@microsoft/fast-element 2.7.0 → 2.8.1

package/CHANGELOG.json

@@ -2,7 +2,37 @@
   "name": "@microsoft/fast-element",
   "entries": [
     {
-      "date": "Wed, 20 Aug 2025 20:56:28 GMT",
+      "date": "Tue, 21 Oct 2025 16:17:03 GMT",
+      "version": "2.8.1",
+      "tag": "@microsoft/fast-element_v2.8.1",
+      "comments": {
+        "patch": [
+          {
+            "author": "863023+radium-v@users.noreply.github.com",
+            "package": "@microsoft/fast-element",
+            "commit": "d66ae6571c97341890e5320048fc1a3ef38dc5be",
+            "comment": "feat: add methods to track hydrating instances"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Mon, 13 Oct 2025 00:37:08 GMT",
+      "version": "2.8.0",
+      "tag": "@microsoft/fast-element_v2.8.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "863023+radium-v@users.noreply.github.com",
+            "package": "@microsoft/fast-element",
+            "commit": "28a1d5dcae41f04e2ff8cb9114c312efb88fb1e1",
+            "comment": "[feat]: implement lifecycle callbacks for hydration and template events"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 20 Aug 2025 20:57:02 GMT",
       "version": "2.7.0",
       "tag": "@microsoft/fast-element_v2.7.0",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,28 @@
 # Change Log - @microsoft/fast-element
 
-<!-- This log was last generated on Wed, 20 Aug 2025 20:56:28 GMT and should not be manually modified. -->
+<!-- This log was last generated on Tue, 21 Oct 2025 16:17:03 GMT and should not be manually modified. -->
 
 <!-- Start content -->
 
+## 2.8.1
+
+Tue, 21 Oct 2025 16:17:03 GMT
+
+### Patches
+
+- feat: add methods to track hydrating instances (863023+radium-v@users.noreply.github.com)
+
+## 2.8.0
+
+Mon, 13 Oct 2025 00:37:08 GMT
+
+### Minor changes
+
+- [feat]: implement lifecycle callbacks for hydration and template events (863023+radium-v@users.noreply.github.com)
+
 ## 2.7.0
 
-Wed, 20 Aug 2025 20:56:28 GMT
+Wed, 20 Aug 2025 20:57:02 GMT
 
 ### Minor changes
 

package/dist/dts/components/element-controller.d.ts

@@ -206,6 +206,24 @@ export declare class StyleElementStrategy implements StyleStrategy {
 }
 export declare const deferHydrationAttribute = "defer-hydration";
 export declare const needsHydrationAttribute = "needs-hydration";
+/**
+ * Lifecycle callbacks for element hydration events
+ * @public
+ */
+export interface HydrationControllerCallbacks {
+    /**
+     * Called before hydration has started
+     */
+    elementWillHydrate?(name: string): void;
+    /**
+     * Called after hydration has finished
+     */
+    elementDidHydrate?(name: string): void;
+    /**
+     * Called after all elements have completed hydration
+     */
+    hydrationComplete?(): void;
+}
 /**
  * An ElementController capable of hydrating FAST elements from
  * Declarative Shadow DOM.
@@ -220,9 +238,47 @@ export declare class HydratableElementController<TElement extends HTMLElement =
      */
     protected needsHydration?: boolean;
     private static hydrationObserver;
+    /**
+     * Lifecycle callbacks for hydration events
+     */
+    static lifecycleCallbacks?: HydrationControllerCallbacks;
+    /**
+     * An idle callback ID used to track hydration completion
+     */
+    private static idleCallbackId;
+    /**
+     * Adds the current element instance to the hydrating instances map
+     */
+    private addHydratingInstance;
+    /**
+     * Configure lifecycle callbacks for hydration events
+     */
+    static config(callbacks: HydrationControllerCallbacks): typeof HydratableElementController;
     private static hydrationObserverHandler;
+    /**
+     * Checks to see if hydration is complete and if so, invokes the hydrationComplete callback.
+     * Then resets the ElementController strategy to the default so that future elements
+     * don't use the HydratableElementController.
+     *
+     * @param deadline - the idle deadline object
+     */
+    private static checkHydrationComplete;
     static forCustomElement(element: HTMLElement, override?: boolean): ElementController<HTMLElement>;
     connect(): void;
+    /**
+     * A map of element instances by the name of the custom element they are
+     * associated with. The key is the custom element name, and the value is the
+     * instances of hydratable elements which currently need to be hydrated.
+     *
+     * When all of the instances in the set have been hydrated, the set is
+     * cleared and removed from the map. If the map is empty, the
+     * hydrationComplete callback is invoked.
+     */
+    private static hydratingInstances?;
+    /**
+     * Removes the current element instance from the hydrating instances map
+     */
+    private removeHydratingInstance;
     disconnect(): void;
     static install(): void;
 }

package/dist/dts/components/fast-definitions.d.ts

@@ -22,10 +22,31 @@ export interface ShadowRootOptions extends ShadowRootInit {
     registry?: CustomElementRegistry;
 }
 /**
- * Template options.
+ * Values for the `templateOptions` property.
  * @alpha
  */
-export declare type TemplateOptions = "defer-and-hydrate";
+export declare const TemplateOptions: {
+    readonly deferAndHydrate: "defer-and-hydrate";
+};
+/**
+ * Type for the `TemplateOptions` const enum.
+ * @alpha
+ */
+export declare type TemplateOptions = (typeof TemplateOptions)[keyof typeof TemplateOptions];
+/**
+ * Lifecycle callbacks for template events.
+ * @public
+ */
+export interface TemplateLifecycleCallbacks {
+    /**
+     * Called after the template has been assigned to the definition
+     */
+    templateDidUpdate?(name: string): void;
+    /**
+     * Called after the custom element has been defined
+     */
+    elementDidDefine?(name: string): void;
+}
 /**
  * Represents metadata configuration for a custom element.
  * @public
@@ -69,6 +90,10 @@ export interface PartialFASTElementDefinition {
      * If not provided, defaults to the global registry.
      */
     readonly registry?: CustomElementRegistry;
+    /**
+     * Lifecycle callbacks for template events.
+     */
+    readonly lifecycleCallbacks?: TemplateLifecycleCallbacks;
 }
 /**
  * Defines metadata for a FASTElement.
@@ -125,6 +150,10 @@ export declare class FASTElementDefinition<TType extends Constructable<HTMLEleme
      * The registry to register this component in by default.
      */
     readonly registry: CustomElementRegistry;
+    /**
+     * Lifecycle callbacks for template events.
+     */
+    readonly lifecycleCallbacks?: TemplateLifecycleCallbacks;
     /**
      * The definition has been registered to the FAST element registry.
      */

package/dist/dts/index.d.ts

@@ -29,6 +29,6 @@ export { ElementView, HTMLView, SyntheticView, View, HydratableView, HydrationBi
 export { elements, ElementsFilter, NodeBehaviorOptions, NodeObservationDirective, } from "./templating/node-observation.js";
 export { render, RenderBehavior, RenderDirective } from "./templating/render.js";
 export { customElement, FASTElement } from "./components/fast-element.js";
-export { FASTElementDefinition, PartialFASTElementDefinition, ShadowRootOptions, fastElementRegistry, TemplateOptions, TypeRegistry, } from "./components/fast-definitions.js";
+export { FASTElementDefinition, PartialFASTElementDefinition, ShadowRootOptions, fastElementRegistry, TemplateOptions, TypeRegistry, type TemplateLifecycleCallbacks, } from "./components/fast-definitions.js";
 export { attr, AttributeConfiguration, AttributeDefinition, AttributeMode, booleanConverter, DecoratorAttributeConfiguration, nullableBooleanConverter, nullableNumberConverter, ValueConverter, } from "./components/attributes.js";
-export { ElementController, ElementControllerStrategy, HydratableElementController, } from "./components/element-controller.js";
+export { ElementController, ElementControllerStrategy, HydratableElementController, type HydrationControllerCallbacks, } from "./components/element-controller.js";

package/dist/esm/components/element-controller.js

@@ -4,7 +4,7 @@ import { ExecutionContext, Observable, SourceLifetime, } from "../observation/ob
 import { FAST, makeSerializationNoop } from "../platform.js";
 import { ElementStyles } from "../styles/element-styles.js";
 import { UnobservableMutationObserver } from "../utilities.js";
-import { FASTElementDefinition } from "./fast-definitions.js";
+import { FASTElementDefinition, TemplateOptions, } from "./fast-definitions.js";
 import { HydrationMarkup, isHydratable } from "./hydration.js";
 const defaultEventOptions = {
     bubbles: true,
@@ -591,32 +591,77 @@ export const needsHydrationAttribute = "needs-hydration";
  * @beta
  */
 export class HydratableElementController extends ElementController {
+    /**
+     * Adds the current element instance to the hydrating instances map
+     */
+    addHydratingInstance() {
+        if (!HydratableElementController.hydratingInstances) {
+            return;
+        }
+        const name = this.definition.name;
+        let instances = HydratableElementController.hydratingInstances.get(name);
+        if (!instances) {
+            instances = new Set();
+            HydratableElementController.hydratingInstances.set(name, instances);
+        }
+        instances.add(this.source);
+    }
+    /**
+     * Configure lifecycle callbacks for hydration events
+     */
+    static config(callbacks) {
+        HydratableElementController.lifecycleCallbacks = callbacks;
+        return this;
+    }
     static hydrationObserverHandler(records) {
         for (const record of records) {
-            HydratableElementController.hydrationObserver.unobserve(record.target);
-            record.target.$fastController.connect();
+            if (!record.target.hasAttribute(deferHydrationAttribute)) {
+                HydratableElementController.hydrationObserver.unobserve(record.target);
+                record.target.$fastController.connect();
+            }
+        }
+    }
+    /**
+     * Checks to see if hydration is complete and if so, invokes the hydrationComplete callback.
+     * Then resets the ElementController strategy to the default so that future elements
+     * don't use the HydratableElementController.
+     *
+     * @param deadline - the idle deadline object
+     */
+    static checkHydrationComplete(deadline) {
+        var _a, _b, _c;
+        if (deadline.didTimeout) {
+            HydratableElementController.idleCallbackId = requestIdleCallback(HydratableElementController.checkHydrationComplete, { timeout: 50 });
+            return;
+        }
+        // If there are no more hydrating instances, invoke the hydrationComplete callback
+        if (((_a = HydratableElementController.hydratingInstances) === null || _a === void 0 ? void 0 : _a.size) === 0) {
+            (_c = (_b = HydratableElementController.lifecycleCallbacks) === null || _b === void 0 ? void 0 : _b.hydrationComplete) === null || _c === void 0 ? void 0 : _c.call(_b);
+            // Reset to the default strategy after hydration is complete
+            ElementController.setStrategy(ElementController);
         }
     }
     static forCustomElement(element, override) {
         const definition = FASTElementDefinition.getForInstance(element);
-        if (definition !== undefined &&
-            definition.templateOptions === "defer-and-hydrate" &&
+        if ((definition === null || definition === void 0 ? void 0 : definition.templateOptions) === TemplateOptions.deferAndHydrate &&
             !definition.template) {
-            element.setAttribute(deferHydrationAttribute, "");
-            element.setAttribute(needsHydrationAttribute, "");
+            element.toggleAttribute(deferHydrationAttribute, true);
+            element.toggleAttribute(needsHydrationAttribute, true);
         }
         return super.forCustomElement(element, override);
     }
     connect() {
-        var _a, _b;
+        var _a, _b, _c, _d, _e;
         // Initialize needsHydration on first connect
-        if (this.needsHydration === undefined) {
-            this.needsHydration =
-                this.source.getAttribute(needsHydrationAttribute) !== null;
+        this.needsHydration =
+            (_a = this.needsHydration) !== null && _a !== void 0 ? _a : this.source.getAttribute(needsHydrationAttribute) !== null;
+        if (this.needsHydration) {
+            (_c = (_b = HydratableElementController.lifecycleCallbacks) === null || _b === void 0 ? void 0 : _b.elementWillHydrate) === null || _c === void 0 ? void 0 : _c.call(_b, this.definition.name);
         }
         // If the `defer-hydration` attribute exists on the source,
         // wait for it to be removed before continuing connection behavior.
         if (this.source.hasAttribute(deferHydrationAttribute)) {
+            this.addHydratingInstance();
             HydratableElementController.hydrationObserver.observe(this.source, {
                 attributeFilter: [deferHydrationAttribute],
             });
@@ -628,6 +673,7 @@ export class HydratableElementController extends ElementController {
         // class
         if (!this.needsHydration) {
             super.connect();
+            this.removeHydratingInstance();
             return;
         }
         if (this.stage !== 3 /* Stages.disconnected */) {
@@ -636,10 +682,10 @@ export class HydratableElementController extends ElementController {
         this.stage = 0 /* Stages.connecting */;
         this.bindObservables();
         this.connectBehaviors();
-        const element = this.source;
-        const host = (_a = getShadowRoot(element)) !== null && _a !== void 0 ? _a : element;
         if (this.template) {
             if (isHydratable(this.template)) {
+                const element = this.source;
+                const host = (_d = getShadowRoot(element)) !== null && _d !== void 0 ? _d : element;
                 let firstChild = host.firstChild;
                 let lastChild = host.lastChild;
                 if (element.shadowRoot === null) {
@@ -654,7 +700,7 @@ export class HydratableElementController extends ElementController {
                     }
                 }
                 this.view = this.template.hydrate(firstChild, lastChild, element);
-                (_b = this.view) === null || _b === void 0 ? void 0 : _b.bind(this.source);
+                (_e = this.view) === null || _e === void 0 ? void 0 : _e.bind(this.source);
             }
             else {
                 this.renderTemplate(this.template);
@@ -664,8 +710,32 @@ export class HydratableElementController extends ElementController {
         this.stage = 1 /* Stages.connected */;
         this.source.removeAttribute(needsHydrationAttribute);
         this.needsInitialization = this.needsHydration = false;
+        this.removeHydratingInstance();
         Observable.notify(this, isConnectedPropertyName);
     }
+    /**
+     * Removes the current element instance from the hydrating instances map
+     */
+    removeHydratingInstance() {
+        var _a, _b;
+        if (!HydratableElementController.hydratingInstances) {
+            return;
+        }
+        const name = this.definition.name;
+        const instances = HydratableElementController.hydratingInstances.get(name);
+        // Callback: After hydration has finished
+        (_b = (_a = HydratableElementController.lifecycleCallbacks) === null || _a === void 0 ? void 0 : _a.elementDidHydrate) === null || _b === void 0 ? void 0 : _b.call(_a, this.definition.name);
+        if (instances) {
+            instances.delete(this.source);
+            if (!instances.size) {
+                HydratableElementController.hydratingInstances.delete(name);
+            }
+            if (HydratableElementController.idleCallbackId) {
+                cancelIdleCallback(HydratableElementController.idleCallbackId);
+            }
+            HydratableElementController.idleCallbackId = requestIdleCallback(HydratableElementController.checkHydrationComplete, { timeout: 50 });
+        }
+    }
     disconnect() {
         super.disconnect();
         HydratableElementController.hydrationObserver.unobserve(this.source);
@@ -675,3 +745,17 @@ export class HydratableElementController extends ElementController {
     }
 }
 HydratableElementController.hydrationObserver = new UnobservableMutationObserver(HydratableElementController.hydrationObserverHandler);
+/**
+ * An idle callback ID used to track hydration completion
+ */
+HydratableElementController.idleCallbackId = null;
+/**
+ * A map of element instances by the name of the custom element they are
+ * associated with. The key is the custom element name, and the value is the
+ * instances of hydratable elements which currently need to be hydrated.
+ *
+ * When all of the instances in the set have been hydrated, the set is
+ * cleared and removed from the map. If the map is empty, the
+ * hydrationComplete callback is invoked.
+ */
+HydratableElementController.hydratingInstances = new Map();

package/dist/esm/components/fast-definitions.js

@@ -21,6 +21,13 @@ const fastElementBaseTypes = new Set();
  * @internal
  */
 export const fastElementRegistry = FAST.getById(KernelServiceId.elementRegistry, () => createTypeRegistry());
+/**
+ * Values for the `templateOptions` property.
+ * @alpha
+ */
+export const TemplateOptions = {
+    deferAndHydrate: "defer-and-hydrate",
+};
 /**
  * Defines metadata for a FASTElement.
  * @public
@@ -84,10 +91,12 @@ export class FASTElementDefinition {
      * This operation is idempotent per registry.
      */
     define(registry = this.registry) {
+        var _b, _c;
         const type = this.type;
         if (!registry.get(this.name)) {
             this.platformDefined = true;
             registry.define(this.name, type, this.elementOptions);
+            (_c = (_b = this.lifecycleCallbacks) === null || _b === void 0 ? void 0 : _b.elementDidDefine) === null || _c === void 0 ? void 0 : _c.call(_b, this.name);
         }
         return this;
     }
@@ -128,15 +137,13 @@ export class FASTElementDefinition {
                 }, nameOrDef));
             }
             const definition = new FASTElementDefinition(type, nameOrDef);
-            Promise.all([
-                new Promise(resolve => {
-                    Observable.getNotifier(definition).subscribe({
-                        handleChange: () => resolve(),
-                    }, "template");
-                }),
-            ]).then(() => {
-                resolve(definition);
-            });
+            Observable.getNotifier(definition).subscribe({
+                handleChange: () => {
+                    var _b, _c;
+                    (_c = (_b = definition.lifecycleCallbacks) === null || _b === void 0 ? void 0 : _b.templateDidUpdate) === null || _c === void 0 ? void 0 : _c.call(_b, definition.name);
+                    resolve(definition);
+                },
+            }, "template");
         });
     }
 }
@@ -165,9 +172,7 @@ FASTElementDefinition.registerAsync = (name) => __awaiter(void 0, void 0, void 0
         if (FASTElementDefinition.isRegistered[name]) {
             resolve(FASTElementDefinition.isRegistered[name]);
         }
-        Observable.getNotifier(FASTElementDefinition.isRegistered).subscribe({
-            handleChange: () => resolve(FASTElementDefinition.isRegistered[name]),
-        }, name);
+        Observable.getNotifier(FASTElementDefinition.isRegistered).subscribe({ handleChange: () => resolve(FASTElementDefinition.isRegistered[name]) }, name);
     });
 });
 Observable.defineProperty(FASTElementDefinition.prototype, "template");

package/dist/esm/index.js

@@ -34,6 +34,6 @@ export { elements, NodeObservationDirective, } from "./templating/node-observati
 export { render, RenderBehavior, RenderDirective } from "./templating/render.js";
 // Components
 export { customElement, FASTElement } from "./components/fast-element.js";
-export { FASTElementDefinition, fastElementRegistry, } from "./components/fast-definitions.js";
+export { FASTElementDefinition, fastElementRegistry, TemplateOptions, } from "./components/fast-definitions.js";
 export { attr, AttributeConfiguration, AttributeDefinition, booleanConverter, nullableBooleanConverter, nullableNumberConverter, } from "./components/attributes.js";
 export { ElementController, HydratableElementController, } from "./components/element-controller.js";

package/dist/esm/polyfills.js

@@ -25,3 +25,36 @@
         result.globalThis = result;
     }
 })();
+(function requestIdleCallbackPolyfill() {
+    if ("requestIdleCallback" in globalThis) {
+        return;
+    }
+    /**
+     * A polyfill for requestIdleCallback that falls back to setTimeout.
+     *
+     * @param callback - The function to call when the browser is idle.
+     * @param options - Options object that may contain a timeout property.
+     * @returns An ID that can be used to cancel the callback.
+     * @public
+     */
+    globalThis.requestIdleCallback = function requestIdleCallback(callback, options) {
+        const start = Date.now();
+        return setTimeout(() => {
+            callback({
+                didTimeout: (options === null || options === void 0 ? void 0 : options.timeout)
+                    ? Date.now() - start >= options.timeout
+                    : false,
+                timeRemaining: () => 0,
+            });
+        }, 1);
+    };
+    /**
+     * A polyfill for cancelIdleCallback that falls back to clearTimeout.
+     *
+     * @param id - The ID of the callback to cancel.
+     * @public
+     */
+    globalThis.cancelIdleCallback = function cancelIdleCallback(id) {
+        clearTimeout(id);
+    };
+})();

package/dist/esm/templating/view.js

@@ -360,7 +360,7 @@ export class HydrationView extends DefaultExecutionContext {
         fragment.appendChild(end);
     }
     bind(source, context = this) {
-        var _b, _c;
+        var _b;
         if (this.hydrationStage !== HydrationStage.hydrated) {
             this._hydrationStage = HydrationStage.hydrating;
         }
@@ -404,7 +404,28 @@ export class HydrationView extends DefaultExecutionContext {
                     if (typeof templateString !== "string") {
                         templateString = templateString.innerHTML;
                     }
-                    throw new HydrationBindingError(`HydrationView was unable to successfully target bindings inside "${(_c = ((_b = this.firstChild) === null || _b === void 0 ? void 0 : _b.getRootNode()).host) === null || _c === void 0 ? void 0 : _c.nodeName}".`, factory, createRangeForNodes(this.firstChild, this.lastChild).cloneContents(), templateString);
+                    const hostElement = ((_b = this.firstChild) === null || _b === void 0 ? void 0 : _b.getRootNode())
+                        .host;
+                    const hostName = (hostElement === null || hostElement === void 0 ? void 0 : hostElement.nodeName) || "unknown";
+                    const factoryInfo = factory;
+                    // Build detailed error message
+                    const details = [
+                        `HydrationView was unable to successfully target bindings inside "<${hostName.toLowerCase()}>".`,
+                        `\nMismatch Details:`,
+                        `  - Expected target node ID: "${factory.targetNodeId}"`,
+                        `  - Available target IDs: [${Object.keys(this.targets).join(", ") || "none"}]`,
+                    ];
+                    if (factory.targetTagName) {
+                        details.push(`  - Expected tag name: "${factory.targetTagName}"`);
+                    }
+                    if (factoryInfo.sourceAspect) {
+                        details.push(`  - Source aspect: "${factoryInfo.sourceAspect}"`);
+                    }
+                    if (factoryInfo.aspectType !== undefined) {
+                        details.push(`  - Aspect type: ${factoryInfo.aspectType}`);
+                    }
+                    details.push(`\nThis usually means:`, `  1. The server-rendered HTML doesn't match the client template`, `  2. The hydration markers are missing or corrupted`, `  3. The DOM structure was modified before hydration`, `\nTemplate: ${templateString.slice(0, 200)}${templateString.length > 200 ? "..." : ""}`);
+                    throw new HydrationBindingError(details.join("\n"), factory, createRangeForNodes(this.firstChild, this.lastChild).cloneContents(), templateString);
                 }
             }
         }