@microsoft/fast-html 1.0.0-alpha.29 → 1.0.0-alpha.30

package/dist/fast-html.api.json

@@ -391,6 +391,60 @@
               "overloadIndex": 1,
               "parameters": []
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/fast-html!TemplateElement.config:member(1)",
+              "docComment": "/**\n * Configure lifecycle callbacks for hydration events.\n *\n * @param callbacks - Lifecycle callbacks to configure.\n *\n * @returns The {@link TemplateElement} class.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static config(callbacks: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HydrationLifecycleCallbacks",
+                  "canonicalReference": "@microsoft/fast-html!~HydrationLifecycleCallbacks:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "typeof "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "TemplateElement",
+                  "canonicalReference": "@microsoft/fast-html!TemplateElement:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": true,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "callbacks",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "config"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/fast-html!TemplateElement#connectedCallback:member(1)",
@@ -486,7 +540,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/fast-html!TemplateElement.options:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Set options for custom elements.\n *\n * @param elementOptions - A dictionary of custom element options\n *\n * @returns The TemplateElement class.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",

package/dist/fast-html.d.ts

@@ -1,5 +1,7 @@
 import { Constructable } from '@microsoft/fast-element';
 import { FASTElement } from '@microsoft/fast-element';
+import { HydrationControllerCallbacks } from '@microsoft/fast-element';
+import { TemplateLifecycleCallbacks } from '@microsoft/fast-element';
 
 declare interface AccessCachedPath extends CachedPathCommon {
     type: AccessCachedPathType;
@@ -28,8 +30,11 @@ declare interface DefaultCachedPath extends CachedPathCommon {
 
 declare type DefaultCachedPathType = "default";
 
+/**
+ * Element options the TemplateElement will use to update the registered element
+ */
 declare interface ElementOptions {
-    observerMap?: ObserverMapOption | undefined;
+    observerMap?: ObserverMapOption;
 }
 
 /**
@@ -45,6 +50,21 @@ declare interface EventCachedPath extends CachedPathCommon {
 
 declare type EventCachedPathType = "event";
 
+/**
+ * Lifecycle callbacks for template and hydration events.
+ * Combines template lifecycle callbacks with hydration callbacks and adds template-processing events.
+ */
+declare interface HydrationLifecycleCallbacks extends HydrationControllerCallbacks, TemplateLifecycleCallbacks {
+    /**
+     * Called after the JS class definition has been registered
+     */
+    elementDidRegister?(name: string): void;
+    /**
+     * Called before the template has been evaluated and assigned
+     */
+    templateWillUpdate?(name: string): void;
+}
+
 declare interface JSONSchema extends JSONSchemaCommon {
     $schema: string;
     $id: string;
@@ -90,7 +110,17 @@ export declare class ObserverMap {
     private defineChanged;
 }
 
-declare type ObserverMapOption = "all";
+/**
+ * Values for the observerMap element option.
+ */
+declare const ObserverMapOption: {
+    readonly all: "all";
+};
+
+/**
+ * Type for the observerMap element option.
+ */
+declare type ObserverMapOption = (typeof ObserverMapOption)[keyof typeof ObserverMapOption];
 
 declare interface RegisterPathConfig {
     rootPropertyName: string;
@@ -231,6 +261,23 @@ export declare class TemplateElement extends FASTElement {
      * Metadata containing JSON schema for properties on a custom eleemnt
      */
     private schema?;
+    /**
+     * Lifecycle callbacks for hydration events
+     */
+    private static lifecycleCallbacks;
+    /**
+     * Configure lifecycle callbacks for hydration events.
+     *
+     * @param callbacks - Lifecycle callbacks to configure.
+     * @returns The {@link TemplateElement} class.
+     */
+    static config(callbacks: HydrationLifecycleCallbacks): typeof TemplateElement;
+    /**
+     * Set options for custom elements.
+     *
+     * @param elementOptions - A dictionary of custom element options
+     * @returns The TemplateElement class.
+     */
     static options(elementOptions?: ElementOptionsDictionary): typeof TemplateElement;
     constructor();
     /**

package/dist/fast-html.untrimmed.d.ts

@@ -1,5 +1,7 @@
 import { Constructable } from '@microsoft/fast-element';
 import { FASTElement } from '@microsoft/fast-element';
+import { HydrationControllerCallbacks } from '@microsoft/fast-element';
+import { TemplateLifecycleCallbacks } from '@microsoft/fast-element';
 
 declare interface AccessCachedPath extends CachedPathCommon {
     type: AccessCachedPathType;
@@ -28,8 +30,11 @@ declare interface DefaultCachedPath extends CachedPathCommon {
 
 declare type DefaultCachedPathType = "default";
 
+/**
+ * Element options the TemplateElement will use to update the registered element
+ */
 declare interface ElementOptions {
-    observerMap?: ObserverMapOption | undefined;
+    observerMap?: ObserverMapOption;
 }
 
 /**
@@ -45,6 +50,21 @@ declare interface EventCachedPath extends CachedPathCommon {
 
 declare type EventCachedPathType = "event";
 
+/**
+ * Lifecycle callbacks for template and hydration events.
+ * Combines template lifecycle callbacks with hydration callbacks and adds template-processing events.
+ */
+declare interface HydrationLifecycleCallbacks extends HydrationControllerCallbacks, TemplateLifecycleCallbacks {
+    /**
+     * Called after the JS class definition has been registered
+     */
+    elementDidRegister?(name: string): void;
+    /**
+     * Called before the template has been evaluated and assigned
+     */
+    templateWillUpdate?(name: string): void;
+}
+
 declare interface JSONSchema extends JSONSchemaCommon {
     $schema: string;
     $id: string;
@@ -90,7 +110,17 @@ export declare class ObserverMap {
     private defineChanged;
 }
 
-declare type ObserverMapOption = "all";
+/**
+ * Values for the observerMap element option.
+ */
+declare const ObserverMapOption: {
+    readonly all: "all";
+};
+
+/**
+ * Type for the observerMap element option.
+ */
+declare type ObserverMapOption = (typeof ObserverMapOption)[keyof typeof ObserverMapOption];
 
 declare interface RegisterPathConfig {
     rootPropertyName: string;
@@ -231,6 +261,23 @@ export declare class TemplateElement extends FASTElement {
      * Metadata containing JSON schema for properties on a custom eleemnt
      */
     private schema?;
+    /**
+     * Lifecycle callbacks for hydration events
+     */
+    private static lifecycleCallbacks;
+    /**
+     * Configure lifecycle callbacks for hydration events.
+     *
+     * @param callbacks - Lifecycle callbacks to configure.
+     * @returns The {@link TemplateElement} class.
+     */
+    static config(callbacks: HydrationLifecycleCallbacks): typeof TemplateElement;
+    /**
+     * Set options for custom elements.
+     *
+     * @param elementOptions - A dictionary of custom element options
+     * @returns The TemplateElement class.
+     */
     static options(elementOptions?: ElementOptionsDictionary): typeof TemplateElement;
     constructor();
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/fast-html",
-  "version": "1.0.0-alpha.29",
+  "version": "1.0.0-alpha.30",
   "type": "module",
   "author": {
     "name": "Microsoft",
@@ -34,7 +34,8 @@
     "build:repeat": "webpack --config ./src/fixtures/repeat/webpack.config.js",
     "build:observer-map": "webpack --config ./src/fixtures/observer-map/webpack.config.js",
     "build:slotted": "webpack --config ./src/fixtures/slotted/webpack.config.js",
-    "build-app": "npm run build:attribute && npm run build:dot-syntax && npm run build:event && npm run build:children && npm run build:binding && npm run build:when && npm run build:ref && npm run build:repeat && npm run build:observer-map && npm run build:slotted",
+    "build:lifecycle-callbacks": "webpack --config ./src/fixtures/lifecycle-callbacks/webpack.config.js",
+    "build-app": "npm run build:attribute && npm run build:dot-syntax && npm run build:event && npm run build:children && npm run build:binding && npm run build:when && npm run build:ref && npm run build:repeat && npm run build:observer-map && npm run build:slotted && npm run build:lifecycle-callbacks",
     "build-server": "tsc -b server",
     "doc": "api-extractor run --local",
     "doc:ci": "api-extractor run",
@@ -44,7 +45,7 @@
     "pretest": "npm run build && npm run build-server",
     "prettier:diff": "prettier --config ../../../.prettierrc \"**/*.{ts,html}\" --list-different",
     "prettier": "prettier --config ../../../.prettierrc --write \"**/*.{ts,html}\"",
-    "test": "npm run build-app && playwright test --config=playwright.config.cjs && npm run test:rules",
+    "test": "npm run build-app && playwright test && npm run test:rules",
     "test-server": "node server/dist/server.js",
     "test:rules": "sg test --skip-snapshot-tests",
     "install-playwright-browsers": "npm run playwright install",
@@ -63,12 +64,12 @@
     "./dist/esm/index.js"
   ],
   "peerDependencies": {
-    "@microsoft/fast-element": "^2.7.0"
+    "@microsoft/fast-element": "^2.8.0"
   },
   "devDependencies": {
     "@ast-grep/cli": "^0.37.0",
     "@microsoft/api-extractor": "^7.47.0",
-    "@microsoft/fast-element": "^2.7.0",
+    "@microsoft/fast-element": "^2.8.0",
     "@playwright/test": "^1.49.0",
     "@types/express": "^4.17.21",
     "@types/node": "^17.0.17",