@microsoft/fast-html 1.0.0-alpha.4 → 1.0.0-alpha.40

package/README.md

@@ -22,7 +22,13 @@ npm install --save @microsoft/fast-html
 In your JS bundle you will need to include the `@microsoft/fast-html` package:
 
 ```typescript
-import { TemplateElement } from "@microsoft/fast-html";
+import { RenderableFASTElement, TemplateElement } from "@microsoft/fast-html";
+import { MyCustomElement } from "./my-custom-element";
+
+RenderableFASTElement(MyCustomElement).defineAsync({
+    name: "my-custom-element",
+    templateOptions: "defer-and-hydrate",
+});
 
 TemplateElement.define({
     name: "f-template",
@@ -45,9 +51,183 @@ Example:
 </f-template>
 ```
 
+#### Non-browser HTML rendering
+
+One of the benefits of FAST declarative HTML templates is that the server can be stack agnostic as JavaScript does not need to be interpreted. By default `@microsoft/fast-html` will expect hydratable content and uses comments and datasets for tracking the binding logic. For more information on what that markup should look like, as well as an example of how initial state may be applied, read our [documentation](./RENDERING.md) to understand what markup should be generated for a hydratable experience. For the sake of brevity hydratable markup will be excluded from the README.
+
+#### Using the RenderableFASTElement
+
+The use of `RenderableFASTElement` as a mixin for your custom element will automatically remove the `defer-hydration` attribute signalling for hydration to begin, and if you need to add state before hydration should occur you can make use of the `prepare` method.
+
+Example:
+```typescript
+class MyCustomElement extends FASTElement {
+    private prepare(): Promise<void> {
+        // Get initial state
+    }
+}
+
+RenderableFASTElement(MyCustomElement).defineAsync({
+    name: "my-custom-element",
+    templateOptions: "defer-and-hydrate",
+});
+```
+
+#### Lifecycle Callbacks
+
+FAST HTML provides lifecycle callbacks that allow you to hook into various stages of template processing and element hydration. These callbacks are useful for tracking the rendering lifecycle, gathering analytics, or coordinating complex initialization sequences.
+
+##### Available Callbacks
+
+**Template Lifecycle Callbacks:**
+- `elementDidRegister(name: string)` - Called after the JavaScript class definition has been registered
+- `templateWillUpdate(name: string)` - Called before the template has been evaluated and assigned
+- `templateDidUpdate(name: string)` - Called after the template has been assigned to the definition
+- `elementDidDefine(name: string)` - Called after the custom element has been defined
+
+**Hydration Lifecycle Callbacks:**
+- `elementWillHydrate(name: string)` - Called before an element begins hydration
+- `elementDidHydrate(name: string)` - Called after an element completes hydration
+- `hydrationComplete()` - Called after all elements have completed hydration
+
+##### Configuring Callbacks
+
+Configure lifecycle callbacks using `TemplateElement.config()`:
+
+```typescript
+import { TemplateElement, type HydrationLifecycleCallbacks } from "@microsoft/fast-html";
+
+// You can configure all callbacks at once
+const callbacks: HydrationLifecycleCallbacks = {
+    elementDidRegister(name: string) {
+        console.log(`Element registered: ${name}`);
+    },
+    templateWillUpdate(name: string) {
+        console.log(`Template updating: ${name}`);
+    },
+    templateDidUpdate(name: string) {
+        console.log(`Template updated: ${name}`);
+    },
+    elementDidDefine(name: string) {
+        console.log(`Element defined: ${name}`);
+    },
+    elementWillHydrate(name: string) {
+        console.log(`Element will hydrate: ${name}`);
+    },
+    elementDidHydrate(name: string) {
+        console.log(`Element hydrated: ${name}`);
+    },
+    hydrationComplete() {
+        console.log('All elements hydrated');
+    }
+};
+
+TemplateElement.config(callbacks);
+
+// Or configure only the callbacks you need
+TemplateElement.config({
+    elementDidHydrate(name: string) {
+        console.log(`${name} is ready`);
+    },
+    hydrationComplete() {
+        console.log('Page is interactive');
+    }
+});
+```
+
+##### Lifecycle Order
+
+The lifecycle callbacks occur in the following general sequence:
+
+1. **Registration Phase**: `elementDidRegister` is called when the element class is registered
+2. **Template Phase**: `templateWillUpdate` → (template processing) → `templateDidUpdate` → `elementDidDefine`
+3. **Hydration Phase**: `elementWillHydrate` → (hydration) → `elementDidHydrate`
+4. **Completion**: `hydrationComplete` is called after all elements finish hydrating
+
+**Note:** Template processing is asynchronous and happens independently for each element. The template and hydration phases can be interleaved when multiple elements are being processed simultaneously.
+
+##### Use Cases
+
+**Performance Monitoring:**
+```typescript
+TemplateElement.config({
+    elementWillHydrate(name: string) {
+        performance.mark(`${name}-hydration-start`);
+    },
+    elementDidHydrate(name: string) {
+        performance.mark(`${name}-hydration-end`);
+        performance.measure(
+            `${name}-hydration`,
+            `${name}-hydration-start`,
+            `${name}-hydration-end`
+        );
+    },
+    hydrationComplete() {
+        // Report to analytics
+        const entries = performance.getEntriesByType('measure');
+        console.log('Hydration metrics:', entries);
+    }
+});
+```
+
+**Loading State Management:**
+```typescript
+TemplateElement.config({
+    elementWillHydrate(name: string) {
+        // Show loading indicator
+        document.body.classList.add('hydrating');
+    },
+    hydrationComplete() {
+        // Hide loading indicator once all elements are ready
+        document.body.classList.remove('hydrating');
+        document.body.classList.add('hydrated');
+    }
+});
+```
+
+**Debugging and Development:**
+```typescript
+if (process.env.NODE_ENV === 'development') {
+    const events: Array<{callback: string; name?: string; timestamp: number}> = [];
+    
+    TemplateElement.config({
+        elementDidRegister(name) {
+            events.push({ callback: 'elementDidRegister', name, timestamp: Date.now() });
+        },
+        templateWillUpdate(name) {
+            events.push({ callback: 'templateWillUpdate', name, timestamp: Date.now() });
+        },
+        templateDidUpdate(name) {
+            events.push({ callback: 'templateDidUpdate', name, timestamp: Date.now() });
+        },
+        elementDidDefine(name) {
+            events.push({ callback: 'elementDidDefine', name, timestamp: Date.now() });
+        },
+        elementWillHydrate(name) {
+            events.push({ callback: 'elementWillHydrate', name, timestamp: Date.now() });
+        },
+        elementDidHydrate(name) {
+            events.push({ callback: 'elementDidHydrate', name, timestamp: Date.now() });
+        },
+        hydrationComplete() {
+            events.push({ callback: 'hydrationComplete', timestamp: Date.now() });
+            console.table(events);
+        }
+    });
+}
+```
+
 ### Syntax
 
-All bindings use a handlebars syntax.
+All bindings use a handlebars-like syntax.
+
+Some bindings are only relevant to the browser, such as for click handlers or other pieces of dynamic interaction. As such, their bindings use single curly braces `{}`, this is to prevent an intial SSR (Server Side Rendering) or other build time rendering technologies from needing to interpret them.
+
+If a binding is relevant to both client and the back end rendering engine, it will use `{{}}` or `{{{}}}` depending on what type of data injection is being done.
+
+Browser-only bindings:
+- Event bindings
+- Attribute directives
 
 #### Content binding
 
@@ -60,33 +240,49 @@ All bindings use a handlebars syntax.
 Event bindings must include the `()` as well as being preceeded by `@` in keeping with `@microsoft/fast-element` tagged template `html` syntax.
 
 ```html
-<button @click="{{handleClick()}}"></button>
+<button @click="{handleClick()}"></button>
+```
+
+In addition you may include an event or attribute or observable, events are denoted with `e` as a reserved letter.
+
+Event:
+```html
+<button @click="{handleClick(e)}"></button>
+```
+
+Attribute/Observable:
+```html
+<button @click="{handleClick(foo)}"></button>
 ```
 
 #### Directives
 
 Directives are assumed to be either an attribute directive or a directive that also serves a template. Both are prepended by `f-`. The logic of these directives and what their use cases are is explained in the [FAST html documentation](https://fast.design/docs/getting-started/html-directives).
 
+Attribute directives are part of [client side binding](#syntax) and therefore use the `{}` syntax.
+
 Attribute directives include:
 - **slotted**
 
     Example:
     ```html
-    <slot f-slotted="{{slottedNodes}}"></slot>
+    <slot f-slotted="{slottedNodes}"></slot>
+    <slot f-slotted="{slottedNodes filter elements()}"></slot>
+    <slot f-slotted="{slottedNodes filter elements(div, p)}"></slot>
     ```
 
 - **children**
 
     Example:
     ```html
-    <ul f-children="{{listItems}}"><f-repeat value="{{item in list}}"><li>{{item}}</li></f-repeat></ul>
+    <ul f-children="{listItems}"><f-repeat value="{{item in list}}"><li>{{item}}</li></f-repeat></ul>
     ```
 
 - **ref**
 
     Example:
     ```html
-    <video f-ref="{{video}}"></video>
+    <video f-ref="{video}"></video>
     ```
 
 Template directives include:
@@ -117,26 +313,54 @@ Where the right operand can be either a reference to a value (string e.g. `{{foo
     <ul><f-repeat value="{{item in list}}"><li>{{item}}</li></f-repeat></ul>
     ```
 
-- **partial & apply**
-
-    These directives are new to the declarative HTML model and allow for the ability to declare a `partial` directive containing a template partial which can then be referenced by an `apply` directive.
+    Should you need to refer to the parent element (not the individual item in the list), you can use the context of a previous repeat, or no context which will resolve to the custom element.
 
     Example:
     ```html
-    <f-partial id="test">
-        <ul>
-            <f-repeat value="{{item in items}}">
-                <li>{{item.text}}<f-apply partial="test" value="{{item.items}}"></f-apply></li>
-            </f-repeat>
-        </ul>
-    </f-partial>
-    <f-apply partial="test" value="{{items}}"></f-apply>
+    <ul><f-repeat value="{{item in list}}"><li>{{item}} - {{title}}</li></f-repeat></ul>
     ```
 
+#### Unescaped HTML
+
+You can add unescaped HTML using triple braces, this will create an additional `div` element as the HTML needs an element to bind to. Where possible it is advisable to not use unescaped HTML and instead use other binding techniques.
+
+Example:
+```html
+{{{html}}}
+```
+
 ### Writing Components
 
 When writing components with the intention of using the declarative HTML syntax, it is imperative that components are written with styling and rendering of the component to be less reliant on any JavaScript state management. An example of this is relying on `elementInterals` state to style a component.
 
+### Converting Components
+
+FAST Components written using the `html` tag template literal can be partially converted via the supplied `.yml` rules made for use with [ast-grep](https://ast-grep.github.io/).
+
+Example:
+
+```ts
+// before
+export const template = html`
+    <slot ${slotted("slottedNodes")}></slot>
+`;
+// after
+export const template = `
+    <slot f-slotted="{slottedNodes}"></slot>
+`;
+```
+
+Which creates a starting point for converting the tag template literals to the declarative HTML syntax.
+
+If your template includes JavaScript specific logic that does not conform to those rules, the fix may not be applied or may apply incorrectly. It is therefore suggested that complex logic instead leverages the custom elements JavaScript class.
+
+#### Available Rules
+
+- `@microsoft/fast-html/rules/attribute-directive.yml`
+- `@microsoft/fast-html/rules/call-expression-with-event-argument.yml`
+- `@microsoft/fast-html/rules/member-expression.yml`
+- `@microsoft/fast-html/rules/tag-function-to-template-literal.yml`
+
 ## Acknowledgements
 
-This project has been heavily inspired by [Handlebars](https://handlebarsjs.com/) and [Vue.js](https://vuejs.org/).
+This project has been heavily inspired by [Handlebars](https://handlebarsjs.com/) and [Vue.js](https://vuejs.org/).

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

@@ -0,0 +1,10 @@
+import { type Constructable, type FASTElement } from "@microsoft/fast-element";
+/**
+ * A mixin function that extends a base class with additional functionality for
+ * rendering and hydration.
+ *
+ * @param BaseCtor - The base class to extend.
+ * @returns A new class that extends the provided base class with additional functionality for rendering and hydration.
+ * @public
+ */
+export declare function RenderableFASTElement<T extends Constructable<FASTElement>>(BaseCtor: T): T;

package/dist/dts/components/index.d.ts

@@ -1 +1,3 @@
-export { TemplateElement } from "./template.js";
+export { RenderableFASTElement } from "./element.js";
+export { ObserverMap } from "./observer-map.js";
+export { ObserverMapOption, TemplateElement, type ElementOptions, type ElementOptionsDictionary, type HydrationLifecycleCallbacks, } from "./template.js";

package/dist/dts/components/observer-map.d.ts

@@ -0,0 +1,27 @@
+import type { Schema } from "./schema.js";
+/**
+ * ObserverMap provides functionality for caching binding paths, extracting root properties,
+ * and defining observable properties on class prototypes
+ */
+export declare class ObserverMap {
+    private schema;
+    private classPrototype;
+    constructor(classPrototype: any, schema: Schema);
+    defineProperties(): void;
+    /**
+     * Creates a proxy for an object that intercepts property mutations and triggers Observable notifications
+     * @param target - The target instance that owns the root property
+     * @param rootProperty - The name of the root property for notification purposes
+     * @param object - The object to wrap with a proxy
+     * @returns A proxy that triggers notifications on property mutations
+     */
+    private getAndAssignObservables;
+    /**
+     * Creates a property change handler function for observable properties
+     * This handler is called when an observable property transitions from undefined to a defined value
+     * @param propertyName - The name of the property for which to create the change handler
+     * @param existingChangedMethod - Optional existing changed method to call after the instance resolver logic
+     * @returns A function that handles property changes and sets up proxies for object values
+     */
+    private defineChanged;
+}

package/dist/dts/components/schema.d.ts

@@ -0,0 +1,144 @@
+import type { ChildrenMap } from "./utilities.js";
+type FastContextMetaData = "$fast_context";
+type FastContextsMetaData = "$fast_parent_contexts";
+export interface JSONSchemaDefinition extends JSONSchemaCommon {
+    $fast_context: string;
+    $fast_parent_contexts: Array<string>;
+}
+interface JSONSchemaCommon {
+    type?: string;
+    properties?: any;
+    items?: any;
+    anyOf?: Array<any>;
+    $ref?: string;
+}
+export interface JSONSchema extends JSONSchemaCommon {
+    $schema: string;
+    $id: string;
+    $defs?: Record<string, JSONSchemaDefinition>;
+}
+interface CachedPathCommon {
+    parentContext: string | null;
+    currentContext: string | null;
+    path: string;
+}
+type AccessCachedPathType = "access";
+export interface AccessCachedPath extends CachedPathCommon {
+    type: AccessCachedPathType;
+}
+type DefaultCachedPathType = "default";
+export interface DefaultCachedPath extends CachedPathCommon {
+    type: DefaultCachedPathType;
+}
+type EventCachedPathType = "event";
+export interface EventCachedPath extends CachedPathCommon {
+    type: EventCachedPathType;
+}
+type RepeatCachedPathType = "repeat";
+export interface RepeatCachedPath extends CachedPathCommon {
+    type: RepeatCachedPathType;
+}
+export type CachedPath = DefaultCachedPath | RepeatCachedPath | AccessCachedPath | EventCachedPath;
+export type CachedPathMap = Map<string, Map<string, JSONSchema>>;
+interface RegisterPathConfig {
+    rootPropertyName: string;
+    pathConfig: CachedPath;
+    childrenMap: ChildrenMap | null;
+}
+export declare const fastContextMetaData: FastContextMetaData;
+export declare const fastContextsMetaData: FastContextsMetaData;
+export declare const defsPropertyName = "$defs";
+export declare const refPropertyName = "$ref";
+/**
+ * A constructed JSON schema from a template
+ */
+export declare class Schema {
+    /**
+     * The name of the custom element
+     */
+    private customElementName;
+    /**
+     * A JSON schema describing each root schema
+     */
+    static jsonSchemaMap: CachedPathMap;
+    constructor(name: string);
+    /**
+     * Add a path to a schema
+     * @param config RegisterPathConfig
+     */
+    addPath(config: RegisterPathConfig): void;
+    /**
+     * Gets the JSON schema for a property name
+     * @param rootPropertyName - the root property the JSON schema is mapped to
+     * @returns The JSON schema for the root property
+     */
+    getSchema(rootPropertyName: string): JSONSchema | null;
+    /**
+     * Gets root properties
+     * @returns IterableIterator<string>
+     */
+    getRootProperties(): IterableIterator<string>;
+    /**
+     * Get a path split into property names
+     * @param path The dot syntax path e.g. a.b.c
+     * @returns An array of items in the path
+     */
+    private getSplitPath;
+    /**
+     * Gets the path to the $def
+     * @param context The context name e.g. {{item in items}} in a repeat creates the "item" context
+     * @returns A string to use as a $ref
+     */
+    private getDefsPath;
+    /**
+     * Get the schema $id
+     * @param customElementName - The custom element name
+     * @param propertyName - The property name
+     * @returns The ID that can be used in the JSON schema as $id
+     */
+    private getSchemaId;
+    /**
+     * Add a new JSON schema to the JSON schema map
+     * @param propertyName The name of the property to assign this JSON schema to
+     */
+    private addNewSchema;
+    /**
+     * Add properties to a context
+     * @param schema The schema to add the properties to
+     * @param splitPath The path split into property/context names
+     * @param context The paths context
+     */
+    private addPropertiesToAContext;
+    /**
+     * Add properties to an object
+     * @param schema The schema to add the properties to
+     * @param splitPath The path split into property/context names
+     * @param context The paths context
+     * @param type The data type (see JSON schema for details)
+     */
+    private addPropertiesToAnObject;
+    /**
+     * Add an array to an object property
+     * @param schema The schema to add the properties to
+     * @param context The name of the context
+     */
+    private addArrayToAnObject;
+    /**
+     * Add a context to the $defs property
+     * @param schema The schema to use
+     * @param propertyName The name of the property the context belongs to
+     * @param currentContext The current context
+     * @param parentContext The parent context
+     * @returns
+     */
+    private addContext;
+    /**
+     * Get parent contexts
+     * @param schema The schema to use
+     * @param parentContext The parent context
+     * @param contexts A list of parent contexts
+     * @returns
+     */
+    private getParentContexts;
+}
+export {};

package/dist/dts/components/template.d.ts

@@ -1,4 +1,41 @@
-import { FASTElement } from "@microsoft/fast-element";
+import { FASTElement, HydrationControllerCallbacks, TemplateLifecycleCallbacks } from "@microsoft/fast-element";
+import "@microsoft/fast-element/install-hydratable-view-templates.js";
+/**
+ * Values for the observerMap element option.
+ */
+export declare const ObserverMapOption: {
+    readonly all: "all";
+};
+/**
+ * Type for the observerMap element option.
+ */
+export type ObserverMapOption = (typeof ObserverMapOption)[keyof typeof ObserverMapOption];
+/**
+ * Element options the TemplateElement will use to update the registered element
+ */
+export interface ElementOptions {
+    observerMap?: ObserverMapOption;
+}
+/**
+ * A dictionary of element options the TemplateElement will use to update the registered element
+ */
+export interface ElementOptionsDictionary<ElementOptionsType = ElementOptions> {
+    [key: string]: ElementOptionsType;
+}
+/**
+ * Lifecycle callbacks for template and hydration events.
+ * Combines template lifecycle callbacks with hydration callbacks and adds template-processing events.
+ */
+export 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;
+}
 /**
  * The <f-template> custom element that will provide view logic to the element
  */
@@ -7,12 +44,52 @@ declare class TemplateElement extends FASTElement {
      * The name of the custom element this template will be applied to
      */
     name?: string;
-    private partials;
+    /**
+     * A dictionary of custom element options
+     */
+    static elementOptions: ElementOptionsDictionary;
+    /**
+     * ObserverMap instance for caching binding paths
+     */
+    private observerMap?;
+    /**
+     * Default element options
+     */
+    private static defaultElementOptions;
+    /**
+     * 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();
+    /**
+     * Set options for a custom element
+     * @param name - The name of the custom element to set options for.
+     */
+    private static setOptions;
     connectedCallback(): void;
     /**
      * Resolve strings and values from an innerHTML string
      * @param innerHTML - The innerHTML.
      * @param self - Indicates that this should refer to itself instead of a property when creating bindings.
+     * @param observerMap - ObserverMap instance for caching binding paths (optional).
      */
     private resolveStringsAndValues;
     /**
@@ -26,6 +103,8 @@ declare class TemplateElement extends FASTElement {
      * @param behaviorConfig - The directive behavior configuration object.
      * @param externalValues - The interpreted values from the parent.
      * @param innerHTML - The innerHTML.
+     * @param self - Indicates that this should refer to itself instead of a property when creating bindings.
+     * @param observerMap - ObserverMap instance for caching binding paths (optional).
      */
     private resolveTemplateDirective;
     /**
@@ -42,6 +121,7 @@ declare class TemplateElement extends FASTElement {
      * @param values - The interpreted values.
      * @param self - Indicates that this should refer to itself instead of a property when creating bindings.
      * @param behaviorConfig - The binding behavior configuration object.
+     * @param observerMap - ObserverMap instance for caching binding paths (optional).
      */
     private resolveDataBinding;
     /**
@@ -50,12 +130,8 @@ declare class TemplateElement extends FASTElement {
      * @param strings - The strings array.
      * @param values - The interpreted values.
      * @param self - Indicates that this should refer to itself instead of a property when creating bindings.
+     * @param observerMap - ObserverMap instance for caching binding paths (optional).
      */
     private resolveInnerHTML;
-    /**
-     * Resolve all partial templates
-     * @param unresolvedInnerHTML - The innerHTML.
-     */
-    private resolveAllPartials;
 }
 export { TemplateElement };