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

package/docs/di/api-report.api.md

@@ -1,315 +0,0 @@
-## API Report File for "@microsoft/fast-element"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-// @public
-export const all: (key: any, searchAncestors?: boolean) => ReturnType<typeof DI.inject>;
-
-// @public
-export type AsyncRegistrationLocator = (key: Key) => Promise<Registration | null>;
-
-// @public
-export interface Container extends ServiceLocator {
-    createChild(config?: Partial<Omit<ContainerConfiguration, "parentLocator">>): Container;
-    getFactory<T extends Constructable>(key: T): Factory<T>;
-    getResolver<K extends Key, T = K>(key: K | Key, autoRegister?: boolean): Resolver<T> | null;
-    register(...params: any[]): Container;
-    // Warning: (ae-forgotten-export) The symbol "Constructable" needs to be exported by the entry point di.d.ts
-    registerFactory<T extends Constructable>(key: T, factory: Factory<T>): void;
-    registerResolver<K extends Key, T = K>(key: K, resolver: Resolver<T>): Resolver<T>;
-    registerTransformer<K extends Key, T = K>(key: K, transformer: Transformer_2<T>): boolean;
-}
-
-// Warning: (ae-forgotten-export) The symbol "ContextDecorator" needs to be exported by the entry point di.d.ts
-//
-// @public
-export const Container: ContextDecorator<Container>;
-
-// @public
-export interface ContainerConfiguration {
-    asyncRegistrationLocator: AsyncRegistrationLocator;
-    defaultResolver(key: Key, handler: Container): Resolver;
-    parentLocator: ParentLocator;
-    responsibleForOwnerRequests: boolean;
-}
-
-// @public
-export const ContainerConfiguration: Readonly<{
-    default: Readonly<ContainerConfiguration>;
-}>;
-
-// Warning: (ae-internal-missing-underscore) The name "ContainerImpl" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export class ContainerImpl implements DOMContainer {
-    constructor(owner: any, config: ContainerConfiguration);
-    // (undocumented)
-    protected config: ContainerConfiguration;
-    // (undocumented)
-    createChild(config?: Partial<Omit<ContainerConfiguration, "parentLocator">>): Container;
-    // (undocumented)
-    get depth(): number;
-    // (undocumented)
-    get<K extends Key>(key: K): Resolved<K>;
-    // (undocumented)
-    getAll<K extends Key>(key: K, searchAncestors?: boolean): readonly Resolved<K>[];
-    // (undocumented)
-    getAsync<K extends Key>(key: K): Promise<Resolved<K>>;
-    // (undocumented)
-    getFactory<K extends Constructable>(Type: K): Factory<K>;
-    // (undocumented)
-    getResolver<K extends Key, T = K>(key: K | Key, autoRegister?: boolean): Resolver<T> | null;
-    // (undocumented)
-    handleContextRequests(enable: boolean): void;
-    // (undocumented)
-    has<K extends Key>(key: K, searchAncestors?: boolean): boolean;
-    // (undocumented)
-    protected owner: any;
-    // (undocumented)
-    get parent(): ContainerImpl | null;
-    // (undocumented)
-    register(...params: any[]): Container;
-    // (undocumented)
-    registerFactory<K extends Constructable>(key: K, factory: Factory<K>): void;
-    // (undocumented)
-    registerResolver<K extends Key, T = K>(key: K, resolver: Resolver<T>): Resolver<T>;
-    // (undocumented)
-    registerTransformer<K extends Key, T = K>(key: K, transformer: Transformer_2<T>): boolean;
-    // (undocumented)
-    get responsibleForOwnerRequests(): boolean;
-}
-
-// @public
-export const DefaultResolver: Readonly<{
-    none(key: Key): Resolver;
-    singleton(key: Key): Resolver;
-    transient(key: Key): Resolver;
-}>;
-
-// @public
-export const DI: Readonly<{
-    installAsContextRequestStrategy(fallback?: () => DOMContainer): void;
-    createContainer(config?: Partial<ContainerConfiguration>): Container;
-    findResponsibleContainer(target: EventTarget, fallback?: () => DOMContainer): DOMContainer;
-    findParentContainer(target: EventTarget, fallback?: () => DOMContainer): DOMContainer;
-    getOrCreateDOMContainer(target?: EventTarget, config?: Partial<Omit<ContainerConfiguration, "parentLocator">>): DOMContainer;
-    getDependencies(Type: Constructable | Injectable): Key[];
-    defineProperty(target: {}, propertyName: string, key: Key, respectConnection?: boolean): void;
-    createContext: typeof createContext;
-    inject(...dependencies: Key[]): (target: any, key?: string | number, descriptor?: PropertyDescriptor | number) => void;
-    transient<T extends Constructable>(target: T & Partial<RegisterSelf<T>>): T & RegisterSelf<T>;
-    singleton<T_1 extends Constructable>(target: T_1 & Partial<RegisterSelf<T_1>>, options?: SingletonOptions): T_1 & RegisterSelf<T_1>;
-}>;
-
-// @public
-export interface DOMContainer extends Container {
-    // @beta
-    handleContextRequests(enable: boolean): void;
-}
-
-// @public
-export const DOMContainer: ContextDecorator<DOMContainer>;
-
-// @public
-export interface Factory<T extends Constructable = any> {
-    construct(container: Container, dynamicDependencies?: Key[]): Resolved<T>;
-    constructAsync(container: Container, dynamicDependencies?: Key[]): Promise<Resolved<T>>;
-    registerTransformer(transformer: Transformer_2<T>): void;
-    readonly Type: T;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "FactoryImpl" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export class FactoryImpl<T extends Constructable = any> implements Factory<T> {
-    constructor(Type: T, dependencies: Key[]);
-    // (undocumented)
-    construct(container: Container, dynamicDependencies?: Key[]): Resolved<T>;
-    // (undocumented)
-    constructAsync(container: Container, dynamicDependencies?: Key[]): Promise<Resolved<T>>;
-    // (undocumented)
-    registerTransformer(transformer: (instance: any) => any): void;
-    // (undocumented)
-    Type: T;
-}
-
-// @public
-export function ignore(target: Injectable, property?: string | number, descriptor?: PropertyDescriptor | number): void;
-
-// @public
-export const inject: (...dependencies: Key[]) => (target: any, key?: string | number, descriptor?: PropertyDescriptor | number) => void;
-
-// @public
-export type Injectable<T = {}> = Constructable<T> & {
-    inject?: Key[];
-};
-
-// @public
-export interface InterfaceConfiguration {
-    friendlyName?: string;
-    respectConnection?: boolean;
-}
-
-// @public
-export type Key = PropertyKey | object | ContextDecorator | Constructable | Resolver;
-
-// @public
-export const lazy: (key: any) => any;
-
-// @public
-export const newInstanceForScope: (key: any) => any;
-
-// @public
-export const newInstanceOf: (key: any) => any;
-
-// @public
-export const optional: (key: any) => any;
-
-// @public
-export type ParentLocator = (owner: any) => Container | null;
-
-// @public
-export type RegisterSelf<T extends Constructable> = {
-    register(container: Container): Resolver<InstanceType<T>>;
-    registerInRequestor: boolean;
-};
-
-// @public
-export interface Registration<K = any> {
-    register(container: Container): Resolver<K>;
-}
-
-// @public
-export const Registration: Readonly<{
-    instance<T>(key: Key, value: T): Registration<T>;
-    singleton<T_1 extends Constructable>(key: Key, value: T_1): Registration<InstanceType<T_1>>;
-    transient<T_2 extends Constructable>(key: Key, value: T_2): Registration<InstanceType<T_2>>;
-    callback<T_3>(key: Key, callback: ResolveCallback<T_3>): Registration<Resolved<T_3>>;
-    cachedCallback<T_4>(key: Key, callback: ResolveCallback<T_4>): Registration<Resolved<T_4>>;
-    aliasTo<T_5>(originalKey: T_5, aliasKey: Key): Registration<Resolved<T_5>>;
-}>;
-
-// @public
-export interface Registry {
-    register(container: Container, ...params: unknown[]): void | Resolver;
-}
-
-// @public
-export type ResolveCallback<T = any> = (handler: Container, requestor: Container, resolver: Resolver<T>) => T;
-
-// Warning: (ae-forgotten-export) The symbol "ResolverLike" needs to be exported by the entry point di.d.ts
-//
-// @public
-export type Resolved<K> = K extends ContextDecorator<infer T> ? T : K extends Constructable ? InstanceType<K> : K extends ResolverLike<any, infer T1> ? T1 extends Constructable ? InstanceType<T1> : T1 : K;
-
-// @public
-export interface Resolver<K = any> extends ResolverLike<Container, K> {
-}
-
-// @public
-export class ResolverBuilder<K> {
-    constructor(container: Container, key: Key);
-    aliasTo(destinationKey: Key): Resolver<K>;
-    cachedCallback(value: ResolveCallback<K>): Resolver<K>;
-    callback(value: ResolveCallback<K>): Resolver<K>;
-    instance(value: K): Resolver<K>;
-    singleton(value: Constructable): Resolver<K>;
-    transient(value: Constructable): Resolver<K>;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "ResolverImpl" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export class ResolverImpl implements Resolver, Registration {
-    // (undocumented)
-    get $isResolver(): true;
-    constructor(key: Key, strategy: ResolverStrategy, state: any);
-    // (undocumented)
-    getFactory(container: Container): Factory | null;
-    // (undocumented)
-    key: Key;
-    // (undocumented)
-    register(container: Container): Resolver;
-    // (undocumented)
-    resolve(handler: Container, requestor: Container): any;
-    // (undocumented)
-    resolveAsync(handler: Container, requestor: Container): Promise<any>;
-    // (undocumented)
-    state: any;
-    // (undocumented)
-    strategy: ResolverStrategy;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "ResolverStrategy" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const enum ResolverStrategy {
-    // (undocumented)
-    alias = 5,
-    // (undocumented)
-    array = 4,
-    // (undocumented)
-    callback = 3,
-    // (undocumented)
-    instance = 0,
-    // (undocumented)
-    singleton = 1,
-    // (undocumented)
-    transient = 2
-}
-
-// @public
-export interface ServiceLocator {
-    get<K extends Key>(key: K): Resolved<K>;
-    get<K extends Key>(key: Key): Resolved<K>;
-    get<K extends Key>(key: K | Key): Resolved<K>;
-    getAll<K extends Key>(key: K, searchAncestors?: boolean): readonly Resolved<K>[];
-    getAll<K extends Key>(key: Key, searchAncestors?: boolean): readonly Resolved<K>[];
-    getAll<K extends Key>(key: K | Key, searchAncestors?: boolean): readonly Resolved<K>[];
-    getAsync<K extends Key>(key: K): Promise<Resolved<K>>;
-    getAsync<K extends Key>(key: Key): Promise<Resolved<K>>;
-    getAsync<K extends Key>(key: K | Key): Promise<Resolved<K>>;
-    has<K extends Key>(key: K | Key, searchAncestors: boolean): boolean;
-}
-
-// @public
-export const ServiceLocator: ContextDecorator<ServiceLocator>;
-
-// Warning: (ae-forgotten-export) The symbol "singletonDecorator" needs to be exported by the entry point di.d.ts
-//
-// @public
-export function singleton<T extends Constructable>(): typeof singletonDecorator;
-
-// @public (undocumented)
-export function singleton<T extends Constructable>(options?: SingletonOptions): typeof singletonDecorator;
-
-// @public
-export function singleton<T extends Constructable>(target: T & Partial<RegisterSelf<T>>): T & RegisterSelf<T>;
-
-// @public
-type Transformer_2<K> = (instance: Resolved<K>) => Resolved<K>;
-export { Transformer_2 as Transformer }
-
-// Warning: (ae-forgotten-export) The symbol "transientDecorator" needs to be exported by the entry point di.d.ts
-//
-// @public
-export function transient<T extends Constructable>(): typeof transientDecorator;
-
-// @public
-export function transient<T extends Constructable>(target: T & Partial<RegisterSelf<T>>): T & RegisterSelf<T>;
-
-// Warning: (ae-internal-missing-underscore) The name "validateKey" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export function validateKey(key: any): void;
-
-// Warnings were encountered during analysis:
-//
-// dist/dts/di/di.d.ts:479:5 - (ae-forgotten-export) The symbol "createContext" needs to be exported by the entry point di.d.ts
-// dist/dts/di/di.d.ts:540:5 - (ae-forgotten-export) The symbol "SingletonOptions" needs to be exported by the entry point di.d.ts
-
-// (No @packageDocumentation comment for this package)
-
-```

package/docs/fast-element-2-changes.md

@@ -1,15 +0,0 @@
-# Changes in FASTElement 2.0
-
-## Breaking Changes
-
-* `HTMLDirective` - The `targetIndex: number` property has been replaced by a `targetId: string` property. The `createBehavior` method no longer takes a target `Node` but instead takes a `BehaviorTargets` instance. The actual target can be looked up on the `BehaviorTargets` instance by indexing with the `targetId` property.
-* `compileTemplate()` - Internals have been significantly changed. The implementation no longer uses a TreeWalker. The return type has change to an `HTMLTemplateCompilationResult` with different properties.
-* `View` and `HTMLView` - Type parameters added to enable strongly typed views based on their data source. The constructor of `HTMLView` has a new signature based on changes to the compiler's output. Internals have been cleaned up and no longer rely on the Range type.
-* `ElementViewTemplate`, `SyntheticViewTemplate`, and `ViewTemplate` - Added type parameters throughout. Logic to instantiate and apply behaviors moved out of the template and into the view where it can be lazily executed. Removed the ability of the `render` method to take a string id of the node to render to. You must provide a node.
-* `DOM` - Tree Walker methods are no longer used and are thus removed. The API for removing child nodes has been removed as well since it was only used in one place and could be inlined. The helper `createCustomAttributePlaceholder()` no longer requires an attribute name. It will be uniquely generated internally.
-* `class` - Bindings to `class` are now more nuanced. Binding directly to `class` will simply set the `className` property. If you need to bind to `class` knowing that manual JS will also manipulate the `classList` in addition to the binding, then you should now bind to `:classList` instead. This allows for performance optimizations in the simple, most common case.
-* `Behavior` and `ViewBehavior` - `Behavior` now requires an `ExecutionContext` for `unbind`. Behaviors can be used for elements or views. `ViewBehavior` has been introduced for use exclusively with views, and provides some optimization opportunities.
-* `RefBehavior` has been replaced with `RefDirective`. The directive also implements `ViewBehavior` allowing a single directive instance to be shared across all template instances that use the ref.
-* Removed `SlottedBehavior` and `ChildrenBehavior` have been replaced with `SlottedDirective` and `ChildrenDirective`. These directives allow a single directive instance to be shared across all template instances that use the ref.
-* Removed `AttachedBehaviorHTMLDirective` and `AttachedBehaviorType` since they are no longer used in the new directive/behavior architecture for ref, slotted, and children.
-* Renamed `Notifier#source` to `Notifier#subject` to align with other observable terminology and prevent name clashes with `BindingObserver` properties.

package/docs/hydration/api-report.api.md

@@ -1,285 +0,0 @@
-## API Report File for "@microsoft/fast-element"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-// @public
-export interface CaptureType {
-}
-
-// @public
-export interface ContentTemplate {
-    create(): ContentView;
-}
-
-// @public
-export interface ContentView {
-    bind(source: any, context?: ExecutionContext): void;
-    // (undocumented)
-    readonly context: ExecutionContext;
-    insertBefore(node: Node): void;
-    remove(): void;
-    unbind(): void;
-}
-
-// @public
-export class DefaultExecutionContext<TParent> implements ExecutionContext<TParent> {
-    get event(): Event;
-    eventDetail<TDetail>(): TDetail;
-    eventTarget<TTarget extends EventTarget>(): TTarget;
-    index: number;
-    get isEven(): boolean;
-    get isFirst(): boolean;
-    get isInMiddle(): boolean;
-    get isLast(): boolean;
-    get isOdd(): boolean;
-    length: number;
-    readonly parent: TParent;
-    readonly parentContext: ExecutionContext<TParent>;
-}
-
-// @beta
-export const deferHydrationAttribute = "defer-hydration";
-
-// @public
-interface Disposable_2 {
-    dispose(): void;
-}
-export { Disposable_2 as Disposable }
-
-// @public
-export const DOMAspect: Readonly<{
-    readonly none: 0;
-    readonly attribute: 1;
-    readonly booleanAttribute: 2;
-    readonly property: 3;
-    readonly content: 4;
-    readonly tokenList: 5;
-    readonly event: 6;
-}>;
-
-// @public
-export type DOMAspect = (typeof DOMAspect)[Exclude<keyof typeof DOMAspect, "none">];
-
-// @public
-export interface DOMPolicy {
-    createHTML(value: string): string;
-    protect(tagName: string | null, aspect: DOMAspect, aspectName: string, sink: DOMSink): DOMSink;
-}
-
-// @public
-export type DOMSink = (target: Node, aspectName: string, value: any, ...args: any[]) => void;
-
-// @public
-export interface ElementView<TSource = any, TParent = any> extends View<TSource, TParent> {
-    appendTo(node: Node): void;
-    onUnbind(behavior: {
-        unbind(controller: ViewController<TSource, TParent>): any;
-    }): void;
-    readonly sourceLifetime?: SourceLifetime;
-}
-
-// @public
-export interface ElementViewTemplate<TSource = any, TParent = any> {
-    create(hostBindingTarget: Element): ElementView<TSource, TParent>;
-    render(source: TSource, host: Node, hostBindingTarget?: Element): ElementView<TSource, TParent>;
-}
-
-// @public
-export function enableHydration(options?: HydrationOptions): void;
-
-// @public
-export interface ExecutionContext<TParent = any> {
-    readonly event: Event;
-    eventDetail<TDetail>(): TDetail;
-    eventTarget<TTarget extends EventTarget>(): TTarget;
-    index: number;
-    readonly isEven: boolean;
-    readonly isFirst: boolean;
-    readonly isInMiddle: boolean;
-    readonly isLast: boolean;
-    readonly isOdd: boolean;
-    length: number;
-    parent: TParent;
-    parentContext: ExecutionContext<TParent>;
-}
-
-// @public
-export const ExecutionContext: Readonly<{
-    default: ExecutionContext<any>;
-    getEvent(): Event | null;
-    setEvent(event: Event | null): void;
-}>;
-
-// @public
-export interface ExpressionController<TSource = any, TParent = any> {
-    readonly context: ExecutionContext<TParent>;
-    readonly isBound: boolean;
-    onUnbind(behavior: {
-        unbind(controller: ExpressionController<TSource, TParent>): any;
-    }): void;
-    readonly source: TSource;
-    readonly sourceLifetime?: SourceLifetime;
-}
-
-// @beta
-export interface HydratableContentTemplate extends ContentTemplate {
-    hydrate(first: Node, last: Node): ContentView;
-}
-
-// @beta
-export interface HydratableElementViewTemplate<TSource = any, TParent = any> extends ElementViewTemplate<TSource, TParent> {
-    // (undocumented)
-    hydrate(firstChild: Node, lastChild: Node, hostBindingTarget?: Element): ElementView<TSource, TParent>;
-}
-
-// @beta
-export interface HydratableSyntheticViewTemplate<TSource = any, TParent = any> extends SyntheticViewTemplate {
-    // (undocumented)
-    hydrate(firstChild: Node, lastChild: Node): SyntheticView<TSource, TParent>;
-}
-
-// @public (undocumented)
-export interface HydratableView<TSource = any, TParent = any> extends ElementView, SyntheticView, DefaultExecutionContext<TParent> {
-    // (undocumented)
-    [Hydratable]: symbol;
-    // (undocumented)
-    readonly bindingViewBoundaries: Record<string, ViewNodes>;
-    // (undocumented)
-    readonly hydrationStage: keyof typeof HydrationStage;
-}
-
-// @beta
-export type HydratableViewController<TSource = any, TParent = any> = HydratableView<TSource, TParent> & ViewController<TSource, TParent>;
-
-// @public (undocumented)
-export class HydrationBindingError extends Error {
-    constructor(
-    message: string | undefined,
-    factory: ViewBehaviorFactory,
-    fragment: DocumentFragment,
-    templateString: string);
-    readonly factory: ViewBehaviorFactory;
-    readonly fragment: DocumentFragment;
-    readonly templateString: string;
-}
-
-// @public
-export interface HydrationOptions {
-    hydrationComplete?(): void;
-    hydrationStarted?(): void;
-}
-
-// @public (undocumented)
-export const HydrationStage: {
-    readonly unhydrated: "unhydrated";
-    readonly hydrating: "hydrating";
-    readonly hydrated: "hydrated";
-};
-
-// @public
-export class HydrationTracker {
-    constructor(options: HydrationOptions);
-    add(element: HTMLElement): void;
-    mergeOptions(incoming: HydrationOptions): void;
-    remove(element: HTMLElement): void;
-}
-
-// @beta
-export function isHydratable(view: ViewController): view is HydratableViewController;
-
-// @beta (undocumented)
-export function isHydratable<TSource = any, TParent = any>(template: SyntheticViewTemplate<TSource, TParent>): template is HydratableSyntheticViewTemplate<TSource, TParent>;
-
-// @beta (undocumented)
-export function isHydratable<TSource = any, TParent = any>(template: ElementViewTemplate<TSource, TParent>): template is HydratableElementViewTemplate<TSource, TParent>;
-
-// @beta (undocumented)
-export function isHydratable(template: ContentTemplate): template is HydratableContentTemplate;
-
-// @public
-export const SourceLifetime: Readonly<{
-    readonly unknown: undefined;
-    readonly coupled: 1;
-}>;
-
-// @public
-export type SourceLifetime = (typeof SourceLifetime)[keyof typeof SourceLifetime];
-
-// @public
-export interface SyntheticView<TSource = any, TParent = any> extends View<TSource, TParent> {
-    readonly firstChild: Node;
-    insertBefore(node: Node): void;
-    readonly lastChild: Node;
-    remove(): void;
-}
-
-// @public
-export interface SyntheticViewTemplate<TSource = any, TParent = any> {
-    create(): SyntheticView<TSource, TParent>;
-    inline(): CaptureType;
-}
-
-// @public
-export interface View<TSource = any, TParent = any> extends Disposable_2 {
-    bind(source: TSource, context?: ExecutionContext<TParent>): void;
-    readonly context: ExecutionContext<TParent>;
-    readonly isBound: boolean;
-    readonly source: TSource | null;
-    unbind(): void;
-}
-
-// @public
-export interface ViewBehavior<TSource = any, TParent = any> {
-    bind(controller: ViewController<TSource, TParent>): void;
-}
-
-// @public
-export interface ViewBehaviorBoundaries {
-    // (undocumented)
-    [factoryId: string]: ViewBoundaries;
-}
-
-// @public
-export interface ViewBehaviorFactory {
-    createBehavior(): ViewBehavior;
-    id?: string;
-    policy?: DOMPolicy;
-    targetNodeId?: string;
-    targetTagName?: string | null;
-}
-
-// @public
-export type ViewBehaviorTargets = {
-    [id: string]: Node;
-};
-
-// @public
-export interface ViewBoundaries {
-    // (undocumented)
-    first: Node;
-    // (undocumented)
-    last: Node;
-}
-
-// @public
-export interface ViewController<TSource = any, TParent = any> extends ExpressionController<TSource, TParent> {
-    readonly isHydrated?: Promise<boolean>;
-    readonly isPrerendered?: Promise<boolean>;
-    // @internal
-    readonly _skipAttrUpdates?: boolean;
-    readonly targets: ViewBehaviorTargets;
-}
-
-// @public (undocumented)
-export interface ViewNodes {
-    // (undocumented)
-    first: Node;
-    // (undocumented)
-    last: Node;
-}
-
-// (No @packageDocumentation comment for this package)
-
-```