@microsoft/fast-element 3.0.0-rc.1 → 3.0.0-rc.2

package/dist/declarative/declarative.api.json

@@ -482,7 +482,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@microsoft/fast-element!AttributeDefinition:class",
-          "docComment": "/**\n * An implementation of `Accessor` that supports reactivity, change callbacks, attribute reflection, and type conversion for custom elements.\n *\n * @public\n */\n",
+          "docComment": "/**\n * An implementation of {@link Accessor} that supports reactivity, change callbacks, attribute reflection, and type conversion for custom elements.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1113,11 +1113,51 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface CaptureType "
+              "text": "export interface CaptureType<TSource = "
+            },
+            {
+              "kind": "Content",
+              "text": "any"
+            },
+            {
+              "kind": "Content",
+              "text": ", TParent = "
+            },
+            {
+              "kind": "Content",
+              "text": "any"
+            },
+            {
+              "kind": "Content",
+              "text": "> "
             }
           ],
           "fileUrlPath": "dist/dts/templating/template.d.ts",
           "releaseTag": "Public",
+          "typeParameters": [
+            {
+              "typeParameterName": "TSource",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "typeParameterName": "TParent",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              }
+            }
+          ],
           "name": "CaptureType",
           "preserveMemberOrder": false,
           "members": [],
@@ -1333,7 +1373,51 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare function declarativeTemplate(callbacks?: "
+              "text": "export declare function declarativeTemplate<TType extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "Constructable",
+              "canonicalReference": "@microsoft/fast-element!Constructable:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLElement",
+              "canonicalReference": "!HTMLElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": " = "
+            },
+            {
+              "kind": "Reference",
+              "text": "Constructable",
+              "canonicalReference": "@microsoft/fast-element!Constructable:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLElement",
+              "canonicalReference": "!HTMLElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ">(callbacks?: "
             },
             {
               "kind": "Reference",
@@ -1349,6 +1433,10 @@
               "text": "FASTElementTemplateResolver",
               "canonicalReference": "@microsoft/fast-element!FASTElementTemplateResolver:type"
             },
+            {
+              "kind": "Content",
+              "text": "<TType>"
+            },
             {
               "kind": "Content",
               "text": ";"
@@ -1356,8 +1444,8 @@
           ],
           "fileUrlPath": "dist/dts/declarative/template.d.ts",
           "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
+            "startIndex": 13,
+            "endIndex": 15
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -1365,12 +1453,25 @@
             {
               "parameterName": "callbacks",
               "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
+                "startIndex": 11,
+                "endIndex": 12
               },
               "isOptional": true
             }
           ],
+          "typeParameters": [
+            {
+              "typeParameterName": "TType",
+              "constraintTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 6,
+                "endIndex": 10
+              }
+            }
+          ],
           "name": "declarativeTemplate"
         },
         {
@@ -1432,17 +1533,316 @@
             }
           ]
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!DOMAspect:type",
+          "docComment": "/**\n * The type of HTML aspect to target.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type DOMAspect = "
+            },
+            {
+              "kind": "Content",
+              "text": "(typeof "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspect",
+              "canonicalReference": "@microsoft/fast-element!DOMAspect:var"
+            },
+            {
+              "kind": "Content",
+              "text": ")["
+            },
+            {
+              "kind": "Reference",
+              "text": "Exclude",
+              "canonicalReference": "!Exclude:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<keyof typeof "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspect",
+              "canonicalReference": "@microsoft/fast-element!DOMAspect:var"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"none\">]"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/dts/dom.d.ts",
+          "releaseTag": "Public",
+          "name": "DOMAspect",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@microsoft/fast-element!DOMAspect:var",
+          "docComment": "/**\n * The type of HTML aspect to target.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "DOMAspect: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Readonly",
+              "canonicalReference": "!Readonly:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<{\n    readonly none: 0;\n    readonly attribute: 1;\n    readonly booleanAttribute: 2;\n    readonly property: 3;\n    readonly content: 4;\n    readonly tokenList: 5;\n    readonly event: 6;\n}>"
+            }
+          ],
+          "fileUrlPath": "dist/dts/dom.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "DOMAspect",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!DOMAspectGuards:type",
+          "docComment": "/**\n * Aspect-specific guards for a DOM Policy.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type DOMAspectGuards = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    ["
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspect.attribute",
+              "canonicalReference": "@microsoft/fast-element!~attribute"
+            },
+            {
+              "kind": "Content",
+              "text": "]?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMSinkGuards",
+              "canonicalReference": "@microsoft/fast-element!DOMSinkGuards:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    ["
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspect.booleanAttribute",
+              "canonicalReference": "@microsoft/fast-element!~booleanAttribute"
+            },
+            {
+              "kind": "Content",
+              "text": "]?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMSinkGuards",
+              "canonicalReference": "@microsoft/fast-element!DOMSinkGuards:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    ["
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspect.property",
+              "canonicalReference": "@microsoft/fast-element!~property"
+            },
+            {
+              "kind": "Content",
+              "text": "]?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMSinkGuards",
+              "canonicalReference": "@microsoft/fast-element!DOMSinkGuards:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    ["
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspect.content",
+              "canonicalReference": "@microsoft/fast-element!~content"
+            },
+            {
+              "kind": "Content",
+              "text": "]?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMSinkGuards",
+              "canonicalReference": "@microsoft/fast-element!DOMSinkGuards:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    ["
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspect.tokenList",
+              "canonicalReference": "@microsoft/fast-element!~tokenList"
+            },
+            {
+              "kind": "Content",
+              "text": "]?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMSinkGuards",
+              "canonicalReference": "@microsoft/fast-element!DOMSinkGuards:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    ["
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspect.event",
+              "canonicalReference": "@microsoft/fast-element!~event"
+            },
+            {
+              "kind": "Content",
+              "text": "]?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMSinkGuards",
+              "canonicalReference": "@microsoft/fast-element!DOMSinkGuards:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/dts/dom-policy.d.ts",
+          "releaseTag": "Public",
+          "name": "DOMAspectGuards",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 26
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!DOMElementGuards:type",
+          "docComment": "/**\n * Element-specific guards for a DOM Policy.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type DOMElementGuards = "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspectGuards",
+              "canonicalReference": "@microsoft/fast-element!DOMAspectGuards:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/dts/dom-policy.d.ts",
+          "releaseTag": "Public",
+          "name": "DOMElementGuards",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!DOMGuards:type",
+          "docComment": "/**\n * Guard configuration for a DOM Policy.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type DOMGuards = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    elements: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMElementGuards",
+              "canonicalReference": "@microsoft/fast-element!DOMElementGuards:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    aspects: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspectGuards",
+              "canonicalReference": "@microsoft/fast-element!DOMAspectGuards:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/dts/dom-policy.d.ts",
+          "releaseTag": "Public",
+          "name": "DOMGuards",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@microsoft/fast-element!DOMPolicy:interface",
-          "docComment": "/**\n * A security policy that FAST can use to interact with the DOM.\n *\n * @public\n */\n",
+          "docComment": "/**\n * A policy that controls whether values can be written to DOM sinks.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
               "text": "export interface DOMPolicy "
             }
           ],
-          "fileUrlPath": "dist/dts/dom.d.ts",
+          "fileUrlPath": "dist/dts/dom-policy.d.ts",
           "releaseTag": "Public",
           "name": "DOMPolicy",
           "preserveMemberOrder": false,
@@ -1512,7 +1912,7 @@
                 {
                   "kind": "Reference",
                   "text": "DOMAspect",
-                  "canonicalReference": "@microsoft/fast-element!~DOMAspect:type"
+                  "canonicalReference": "@microsoft/fast-element!DOMAspect:type"
                 },
                 {
                   "kind": "Content",
@@ -1529,7 +1929,7 @@
                 {
                   "kind": "Reference",
                   "text": "DOMSink",
-                  "canonicalReference": "@microsoft/fast-element!~DOMSink:type"
+                  "canonicalReference": "@microsoft/fast-element!DOMSink:type"
                 },
                 {
                   "kind": "Content",
@@ -1538,7 +1938,7 @@
                 {
                   "kind": "Reference",
                   "text": "DOMSink",
-                  "canonicalReference": "@microsoft/fast-element!~DOMSink:type"
+                  "canonicalReference": "@microsoft/fast-element!DOMSink:type"
                 },
                 {
                   "kind": "Content",
@@ -1591,6 +1991,207 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@microsoft/fast-element!DOMPolicy:var",
+          "docComment": "/**\n * A helper for creating DOM policies.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "DOMPolicy: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Readonly",
+              "canonicalReference": "!Readonly:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<{\n    create(options?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMPolicyOptions",
+              "canonicalReference": "@microsoft/fast-element!DOMPolicyOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Readonly",
+              "canonicalReference": "!Readonly:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMPolicy",
+              "canonicalReference": "@microsoft/fast-element!DOMPolicy:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n}>"
+            }
+          ],
+          "fileUrlPath": "dist/dts/dom-policy.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "DOMPolicy",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 9
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!DOMPolicyOptions:type",
+          "docComment": "/**\n * Options for creating a DOM Policy.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type DOMPolicyOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    trustedType?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "TrustedTypesPolicy",
+              "canonicalReference": "@microsoft/fast-element!TrustedTypesPolicy:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    guards?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Partial",
+              "canonicalReference": "!Partial:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMGuards",
+              "canonicalReference": "@microsoft/fast-element!DOMGuards:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/dts/dom-policy.d.ts",
+          "releaseTag": "Public",
+          "name": "DOMPolicyOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!DOMSink:type",
+          "docComment": "/**\n * A function used to send values to a DOM sink.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type DOMSink = "
+            },
+            {
+              "kind": "Content",
+              "text": "(target: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Node",
+              "canonicalReference": "!Node:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", aspectName: string, value: any, ...args: any[]) => void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/dts/dom.d.ts",
+          "releaseTag": "Public",
+          "name": "DOMSink",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!DOMSinkGuards:type",
+          "docComment": "/**\n * A specific DOM sink guard for a node aspect.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type DOMSinkGuards = "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, (tagName: string | null, aspect: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMAspect",
+              "canonicalReference": "@microsoft/fast-element!DOMAspect:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", aspectName: string, sink: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMSink",
+              "canonicalReference": "@microsoft/fast-element!DOMSink:type"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Reference",
+              "text": "DOMSink",
+              "canonicalReference": "@microsoft/fast-element!DOMSink:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/dts/dom-policy.d.ts",
+          "releaseTag": "Public",
+          "name": "DOMSinkGuards",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 9
+          }
+        },
         {
           "kind": "Class",
           "canonicalReference": "@microsoft/fast-element!ElementStyles:class",
@@ -6294,6 +6895,10 @@
                   "text": "CaptureType",
                   "canonicalReference": "@microsoft/fast-element!CaptureType:interface"
                 },
+                {
+                  "kind": "Content",
+                  "text": "<TSource, TParent>"
+                },
                 {
                   "kind": "Content",
                   "text": ";"
@@ -6302,7 +6907,7 @@
               "isOptional": false,
               "returnTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 3
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -6815,6 +7420,10 @@
               "text": "CaptureType",
               "canonicalReference": "@microsoft/fast-element!CaptureType:interface"
             },
+            {
+              "kind": "Content",
+              "text": "<TSource, TParent>"
+            },
             {
               "kind": "Content",
               "text": ";"
@@ -6849,7 +7458,33 @@
           ],
           "typeTokenRange": {
             "startIndex": 3,
-            "endIndex": 10
+            "endIndex": 11
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!TrustedTypesPolicy:type",
+          "docComment": "/**\n * A policy for use with the standard trustedTypes platform API.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type TrustedTypesPolicy = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    createHTML(html: string): string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/dts/interfaces.d.ts",
+          "releaseTag": "Public",
+          "name": "TrustedTypesPolicy",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
           }
         },
         {
@@ -7672,6 +8307,10 @@
                   "text": "CaptureType",
                   "canonicalReference": "@microsoft/fast-element!CaptureType:interface"
                 },
+                {
+                  "kind": "Content",
+                  "text": "<TSource, TParent>"
+                },
                 {
                   "kind": "Content",
                   "text": ";"
@@ -7680,7 +8319,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 3
               },
               "releaseTag": "Public",
               "isProtected": false,