@microsoft/fast-html 1.0.0-alpha.21 → 1.0.0-alpha.23

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

@@ -1,3 +1,4 @@
+import { type ChildrenMap } from "./utilities.js";
 type FastContextMetaData = "$fast_context";
 type FastContextsMetaData = "$fast_parent_contexts";
 export interface JSONSchemaDefinition extends JSONSchemaCommon {
@@ -8,6 +9,7 @@ interface JSONSchemaCommon {
     type?: string;
     properties?: any;
     items?: any;
+    anyOf?: Array<any>;
 }
 export interface JSONSchema extends JSONSchemaCommon {
     $schema: string;
@@ -37,10 +39,11 @@ export interface RepeatCachedPath extends CachedPathCommon {
     type: RepeatCachedPathType;
 }
 export type CachedPath = DefaultCachedPath | RepeatCachedPath | AccessCachedPath | EventCachedPath;
-export type CachedPathMap = Map<string, JSONSchema>;
+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;
@@ -57,7 +60,7 @@ export declare class Schema {
     /**
      * A JSON schema describing each root schema
      */
-    private jsonSchemaMap;
+    static jsonSchemaMap: CachedPathMap;
     constructor(name: string);
     /**
      * Add a path to a schema
@@ -87,6 +90,13 @@ export declare class Schema {
      * @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

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

@@ -22,7 +22,6 @@ declare class TemplateElement extends FASTElement {
      * A dictionary of custom element options
      */
     static elementOptions: ElementOptionsDictionary;
-    private partials;
     /**
      * ObserverMap instance for caching binding paths
      */

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

@@ -36,6 +36,10 @@ export interface TemplateDirectiveBehaviorConfig extends BehaviorConfig {
     closingTagStartIndex: number;
     closingTagEndIndex: number;
 }
+export interface ChildrenMap {
+    customElementName: string;
+    attributeName: string;
+}
 /**
  * Get the index of the next matching tag
  * @param openingTagStartSlice - The slice starting from the opening tag
@@ -59,7 +63,7 @@ export declare function getNextBehavior(innerHTML: string): DataBindingBehaviorC
  * @returns A function to access the value from a given path.
  */
 export declare function pathResolver(path: string, contextPath: string | null, level: number, rootSchema: JSONSchema): (accessibleObject: any, context: any) => any;
-export declare function bindingResolver(rootPropertyName: string | null, path: string, parentContext: string | null, type: PathType, schema: Schema, currentContext: string | null, level: number): (accessibleObject: any, context: any) => any;
+export declare function bindingResolver(previousString: string | null, rootPropertyName: string | null, path: string, parentContext: string | null, type: PathType, schema: Schema, currentContext: string | null, level: number): (accessibleObject: any, context: any) => any;
 export declare function expressionResolver(rootPropertyName: string | null, expression: ChainedExpression, parentContext: string | null, level: number, schema: Schema): (accessibleObject: any, context: any) => any;
 /**
  * Extracts all paths from a ChainedExpression, including nested expressions
@@ -145,4 +149,10 @@ export declare function assignProxy(schema: JSONSchema | JSONSchemaDefinition, r
  * @returns
  */
 export declare function getRootPropertyName(rootPropertyName: string | null, path: string, context: null | string, type: PathType): string | null;
+/**
+ * Get details of bindings to the attributes of child custom elements
+ * @param previousString - The previous string before the binding
+ * @returns null, or a custom element name and attribute name
+ */
+export declare function getChildrenMap(previousString: string | null): ChildrenMap | null;
 export {};

package/dist/esm/components/schema.js

@@ -9,11 +9,8 @@ export const refPropertyName = "$ref";
  */
 export class Schema {
     constructor(name) {
-        /**
-         * A JSON schema describing each root schema
-         */
-        this.jsonSchemaMap = new Map();
         this.customElementName = name;
+        Schema.jsonSchemaMap.set(this.customElementName, new Map());
     }
     /**
      * Add a path to a schema
@@ -22,18 +19,27 @@ export class Schema {
     addPath(config) {
         var _a, _b, _c;
         const splitPath = this.getSplitPath(config.pathConfig.path);
-        let schema = this.jsonSchemaMap.get(config.rootPropertyName);
+        let schema = Schema.jsonSchemaMap.get(this.customElementName).get(config.rootPropertyName);
+        let childRef = null;
         // Create a root level property JSON
         if (!schema) {
             this.addNewSchema(config.rootPropertyName);
-            schema = this.jsonSchemaMap.get(config.rootPropertyName);
+            schema = Schema.jsonSchemaMap.get(this.customElementName).get(config.rootPropertyName);
+        }
+        if (config.childrenMap) {
+            childRef = this.getSchemaId(config.childrenMap.customElementName, config.childrenMap.attributeName);
+            if (splitPath.length === 1) {
+                schema.anyOf
+                    ? schema.anyOf.push({ [refPropertyName]: childRef })
+                    : (schema.anyOf = [{ [refPropertyName]: childRef }]);
+            }
         }
         switch (config.pathConfig.type) {
             case "default":
             case "access": {
                 if (splitPath.length > 1) {
                     if (config.pathConfig.currentContext === null) {
-                        this.addPropertiesToAnObject(schema, splitPath.slice(1), config.pathConfig.currentContext);
+                        this.addPropertiesToAnObject(schema, splitPath.slice(1), config.pathConfig.currentContext, childRef);
                     }
                     else {
                         if (!((_a = schema[defsPropertyName]) === null || _a === void 0 ? void 0 : _a[splitPath[0]])) {
@@ -41,7 +47,7 @@ export class Schema {
                                 [splitPath[0]]: {},
                             };
                         }
-                        this.addPropertiesToAContext(schema[defsPropertyName][splitPath[0]], splitPath.slice(1), config.pathConfig.currentContext);
+                        this.addPropertiesToAContext(schema[defsPropertyName][splitPath[0]], splitPath.slice(1), config.pathConfig.currentContext, childRef);
                     }
                 }
                 break;
@@ -54,16 +60,16 @@ export class Schema {
                     let updatedSchema = schema;
                     const hasParentContext = !!config.pathConfig.parentContext;
                     if (hasParentContext) {
-                        updatedSchema = this.addPropertiesToAnObject((_b = schema[defsPropertyName]) === null || _b === void 0 ? void 0 : _b[config.pathConfig.parentContext], splitPath.slice(1, -1), config.pathConfig.parentContext);
+                        updatedSchema = this.addPropertiesToAnObject((_b = schema[defsPropertyName]) === null || _b === void 0 ? void 0 : _b[config.pathConfig.parentContext], splitPath.slice(1, -1), config.pathConfig.parentContext, childRef);
                     }
-                    this.addPropertiesToAnObject(updatedSchema, hasParentContext ? splitPath.slice(2) : splitPath.slice(1), config.pathConfig.currentContext, "array");
+                    this.addPropertiesToAnObject(updatedSchema, hasParentContext ? splitPath.slice(2) : splitPath.slice(1), config.pathConfig.currentContext, childRef, "array");
                 }
                 else if (splitPath.length > 1) {
                     let schemaDefinition;
                     if (config.pathConfig.parentContext) {
                         schemaDefinition = (_c = schema === null || schema === void 0 ? void 0 : schema[defsPropertyName]) === null || _c === void 0 ? void 0 : _c[config.pathConfig.parentContext];
                     }
-                    this.addPropertiesToAnObject(schemaDefinition !== null && schemaDefinition !== void 0 ? schemaDefinition : schema, splitPath.slice(1), config.pathConfig.currentContext, "array");
+                    this.addPropertiesToAnObject(schemaDefinition !== null && schemaDefinition !== void 0 ? schemaDefinition : schema, splitPath.slice(1), config.pathConfig.currentContext, childRef, "array");
                 }
                 else {
                     schema.type = "array";
@@ -80,14 +86,14 @@ export class Schema {
      */
     getSchema(rootPropertyName) {
         var _a;
-        return (_a = this.jsonSchemaMap.get(rootPropertyName)) !== null && _a !== void 0 ? _a : null;
+        return ((_a = Schema.jsonSchemaMap.get(this.customElementName).get(rootPropertyName)) !== null && _a !== void 0 ? _a : null);
     }
     /**
      * Gets root properties
      * @returns IterableIterator<string>
      */
     getRootProperties() {
-        return this.jsonSchemaMap.keys();
+        return Schema.jsonSchemaMap.get(this.customElementName).keys();
     }
     /**
      * Get a path split into property names
@@ -105,14 +111,23 @@ export class Schema {
     getDefsPath(context) {
         return `#/${defsPropertyName}/${context}`;
     }
+    /**
+     * 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
+     */
+    getSchemaId(customElementName, propertyName) {
+        return `https://fast.design/schemas/${customElementName}/${propertyName}.json`;
+    }
     /**
      * Add a new JSON schema to the JSON schema map
      * @param propertyName The name of the property to assign this JSON schema to
      */
     addNewSchema(propertyName) {
-        this.jsonSchemaMap.set(propertyName, {
+        Schema.jsonSchemaMap.get(this.customElementName).set(propertyName, {
             $schema: "https://json-schema.org/draft/2019-09/schema",
-            $id: `https://fast.design/schemas/${this.customElementName}/${propertyName}.json`,
+            $id: this.getSchemaId(this.customElementName, propertyName),
             [defsPropertyName]: {},
         });
     }
@@ -122,7 +137,7 @@ export class Schema {
      * @param splitPath The path split into property/context names
      * @param context The paths context
      */
-    addPropertiesToAContext(schema, splitPath, context) {
+    addPropertiesToAContext(schema, splitPath, context, childRef) {
         schema.type = "object";
         if (schema.properties && !schema.properties[splitPath[0]]) {
             schema.properties[splitPath[0]] = {};
@@ -133,7 +148,17 @@ export class Schema {
             };
         }
         if (splitPath.length > 1) {
-            this.addPropertiesToAnObject(schema.properties[splitPath[0]], splitPath.slice(1), context);
+            this.addPropertiesToAnObject(schema.properties[splitPath[0]], splitPath.slice(1), context, childRef);
+        }
+        else if (childRef) {
+            if (schema.properties[splitPath[0]].anyOf) {
+                schema.properties[splitPath[0]].anyOf.push({
+                    [refPropertyName]: childRef,
+                });
+            }
+            else {
+                schema.properties[splitPath[0]].anyOf = [{ [refPropertyName]: childRef }];
+            }
         }
     }
     /**
@@ -143,7 +168,7 @@ export class Schema {
      * @param context The paths context
      * @param type The data type (see JSON schema for details)
      */
-    addPropertiesToAnObject(schema, splitPath, context, type = "object") {
+    addPropertiesToAnObject(schema, splitPath, context, childRef, type = "object") {
         schema.type = "object";
         if (schema.properties && !schema.properties[splitPath[0]]) {
             schema.properties[splitPath[0]] = {};
@@ -154,16 +179,22 @@ export class Schema {
             };
         }
         if (type === "object" && splitPath.length > 1) {
-            return this.addPropertiesToAnObject(schema.properties[splitPath[0]], splitPath.slice(1), context, type);
+            return this.addPropertiesToAnObject(schema.properties[splitPath[0]], splitPath.slice(1), context, childRef, type);
         }
         else if (type === "array") {
             if (splitPath.length > 1) {
-                return this.addPropertiesToAnObject(schema.properties[splitPath[0]], splitPath.slice(1), context, type);
+                return this.addPropertiesToAnObject(schema.properties[splitPath[0]], splitPath.slice(1), context, childRef, type);
             }
             else {
                 return this.addArrayToAnObject(schema.properties[splitPath[0]], context);
             }
         }
+        if (schema.properties[splitPath[0]].anyOf && childRef) {
+            schema.properties[splitPath[0]].anyOf.push({ [refPropertyName]: childRef });
+        }
+        else if (childRef) {
+            schema.properties[splitPath[0]].anyOf = [{ [refPropertyName]: childRef }];
+        }
         return schema.properties[splitPath[0]];
     }
     /**
@@ -213,3 +244,7 @@ export class Schema {
         return this.getParentContexts(schema, parentParentContext.at(-1), [parentContext, ...contexts]);
     }
 }
+/**
+ * A JSON schema describing each root schema
+ */
+Schema.jsonSchemaMap = new Map();