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

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

@@ -1,114 +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 ArrayObserver extends SubscriberSet {
-    addSort(sort: Sort): void;
-    addSplice(splice: Splice): void;
-    flush(): void;
-    readonly lengthObserver: LengthObserver;
-    reset(oldCollection: any[] | undefined): void;
-    readonly sortObserver: SortObserver;
-    strategy: SpliceStrategy | null;
-}
-
-// @public
-export const ArrayObserver: Readonly<{
-    readonly sorted: 0;
-    readonly enable: () => void;
-}>;
-
-// @public
-export interface LengthObserver extends Subscriber {
-    length: number;
-}
-
-// @public
-export function lengthOf<T>(array: readonly T[]): number;
-
-// @public
-export interface Notifier {
-    notify(args: any): void;
-    readonly subject: any;
-    subscribe(subscriber: Subscriber, propertyToWatch?: any): void;
-    unsubscribe(subscriber: Subscriber, propertyToUnwatch?: any): void;
-}
-
-// @public
-export class Sort {
-    constructor(sorted?: number[] | undefined);
-    // (undocumented)
-    sorted?: number[] | undefined;
-}
-
-// @public
-export function sortedCount<T>(array: readonly T[]): number;
-
-// @public
-export interface SortObserver extends Subscriber {
-    sorted: number;
-}
-
-// @public
-export class Splice {
-    constructor(index: number, removed: any[], addedCount: number);
-    // (undocumented)
-    addedCount: number;
-    adjustTo(array: any[]): this;
-    // (undocumented)
-    index: number;
-    // (undocumented)
-    removed: any[];
-    reset?: boolean;
-}
-
-// @public
-export interface SpliceStrategy {
-    normalize(previous: unknown[] | undefined, current: unknown[], changes: Splice[] | undefined): readonly Splice[];
-    pop(array: any[], observer: ArrayObserver, pop: typeof Array.prototype.pop, args: any[]): any;
-    push(array: any[], observer: ArrayObserver, push: typeof Array.prototype.push, args: any[]): any;
-    reverse(array: any[], observer: ArrayObserver, reverse: typeof Array.prototype.reverse, args: any[]): any;
-    shift(array: any[], observer: ArrayObserver, shift: typeof Array.prototype.shift, args: any[]): any;
-    sort(array: any[], observer: ArrayObserver, sort: typeof Array.prototype.sort, args: any[]): any[];
-    splice(array: any[], observer: ArrayObserver, splice: typeof Array.prototype.splice, args: any[]): any;
-    readonly support: SpliceStrategySupport;
-    unshift(array: any[], observer: ArrayObserver, unshift: typeof Array.prototype.unshift, args: any[]): any[];
-}
-
-// @public
-export const SpliceStrategy: Readonly<{
-    readonly reset: Splice[];
-    readonly setDefaultStrategy: (strategy: SpliceStrategy) => void;
-}>;
-
-// @public
-export const SpliceStrategySupport: Readonly<{
-    readonly reset: 1;
-    readonly splice: 2;
-    readonly optimized: 3;
-}>;
-
-// @public
-export type SpliceStrategySupport = (typeof SpliceStrategySupport)[keyof typeof SpliceStrategySupport];
-
-// @public
-export interface Subscriber {
-    handleChange(subject: any, args: any): void;
-}
-
-// @public
-export class SubscriberSet implements Notifier {
-    constructor(subject: any, initialSubscriber?: Subscriber);
-    has(subscriber: Subscriber): boolean;
-    notify(args: any): void;
-    readonly subject: any;
-    subscribe(subscriber: Subscriber): void;
-    unsubscribe(subscriber: Subscriber): void;
-}
-
-// (No @packageDocumentation comment for this package)
-
-```

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

@@ -1,69 +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 type Context<T> = {
-    readonly name: string;
-    readonly initialValue?: T;
-};
-
-// @public
-export const Context: Readonly<{
-    eventType: "context-request";
-    for<T = unknown>(name: string): FASTContext<T>;
-    create<T_1 = unknown>(name: string, initialValue?: T_1 | undefined): FASTContext<T_1>;
-    setDefaultRequestStrategy(strategy: FASTContextRequestStrategy): void;
-    get<T_2 extends UnknownContext>(target: EventTarget, context: T_2): ContextType<T_2>;
-    request<T_3 extends UnknownContext>(target: EventTarget, context: T_3, callback: ContextCallback<ContextType<T_3>>, multiple?: boolean): void;
-    dispatch<T_4 extends UnknownContext>(target: EventTarget, context: T_4, callback: ContextCallback<ContextType<T_4>>, multiple?: boolean): void;
-    provide<T_5 extends UnknownContext>(target: EventTarget, context: T_5, value: ContextType<T_5>): void;
-    handle<T_6 extends UnknownContext>(target: EventTarget, callback: (event: ContextEvent<T_6>) => void, context?: T_6 | undefined): void;
-    defineProperty<T_7 extends UnknownContext>(target: Constructable<EventTarget> | EventTarget, propertyName: string, context: T_7): void;
-}>;
-
-// @public
-export type ContextCallback<ValueType> = (value: ValueType, dispose?: () => void) => void;
-
-// Warning: (ae-forgotten-export) The symbol "ParameterDecorator_2" needs to be exported by the entry point context.d.ts
-//
-// @public
-export type ContextDecorator<T = any> = Readonly<Context<T>> & PropertyDecorator & ParameterDecorator_2;
-
-// @public
-export class ContextEvent<T extends UnknownContext> extends Event {
-    constructor(context: T, callback: ContextCallback<ContextType<T>>, multiple?: boolean | undefined);
-    // (undocumented)
-    readonly callback: ContextCallback<ContextType<T>>;
-    // (undocumented)
-    readonly context: T;
-    // (undocumented)
-    readonly multiple?: boolean | undefined;
-}
-
-// @public
-export type ContextType<T extends UnknownContext> = T extends Context<infer Y> ? Y : never;
-
-// @public
-export type FASTContext<T> = ContextDecorator<T> & {
-    get(target: EventTarget): T;
-    provide(target: EventTarget, value: T): void;
-    request(target: EventTarget, callback: ContextCallback<T>, multiple?: boolean): void;
-    handle(target: EventTarget, callback: (event: ContextEvent<FASTContext<T>>) => void): void;
-};
-
-// @public
-export type FASTContextRequestStrategy = <T extends UnknownContext>(target: EventTarget, context: T, callback: ContextCallback<ContextType<T>>, multiple: any) => void;
-
-// @public
-export type UnknownContext = Context<unknown>;
-
-// Warnings were encountered during analysis:
-//
-// dist/dts/context.d.ts:127:5 - (ae-forgotten-export) The symbol "Constructable" needs to be exported by the entry point context.d.ts
-
-// (No @packageDocumentation comment for this package)
-
-```

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

@@ -1,397 +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 AccessCachedPath extends CachedPathCommon {
-    // (undocumented)
-    type: "access";
-}
-
-// @public
-export interface Accessor {
-    getValue(source: any): any;
-    name: string;
-    setValue(source: any, value: any): void;
-}
-
-// @public
-export type AttributeConfiguration = {
-    property: string;
-    attribute?: string;
-    mode?: AttributeMode;
-    converter?: ValueConverter;
-};
-
-// @public
-export const AttributeConfiguration: Readonly<{
-    locate: (target: {}) => AttributeConfiguration[];
-}>;
-
-// @public
-export class AttributeDefinition implements Accessor {
-    constructor(Owner: Function, name: string, attribute?: string, mode?: AttributeMode, converter?: ValueConverter);
-    readonly attribute: string;
-    // @internal
-    static collect(Owner: Function, ...attributeLists: (ReadonlyArray<string | AttributeConfiguration> | undefined)[]): ReadonlyArray<AttributeDefinition>;
-    readonly converter?: ValueConverter;
-    getValue(source: HTMLElement): any;
-    readonly mode: AttributeMode;
-    readonly name: string;
-    // @internal (undocumented)
-    onAttributeChangedCallback(element: HTMLElement, value: any): void;
-    readonly Owner: Function;
-    setValue(source: HTMLElement, newValue: any): void;
-}
-
-// @public
-export type AttributeMode = "reflect" | "boolean" | "fromView";
-
-// @public
-export type CachedPath = DefaultCachedPath | RepeatCachedPath | AccessCachedPath | EventCachedPath;
-
-// @public
-export interface CachedPathCommon {
-    // (undocumented)
-    currentContext: string | null;
-    // (undocumented)
-    parentContext: string | null;
-    // (undocumented)
-    path: string;
-}
-
-// @public
-export type CachedPathMap = Map<string, Map<string, JSONSchema>>;
-
-// @public
-export interface CaptureType {
-}
-
-// @public
-export interface ChildrenMap {
-    // (undocumented)
-    attributeName: string;
-    // (undocumented)
-    customElementName: string;
-}
-
-// @public
-export type ComposableStyles = string | ElementStyles | CSSStyleSheet;
-
-// @public
-export type Constructable<T = {}> = {
-    new (...args: any[]): T;
-};
-
-// @public
-export type ConstructibleStyleStrategy = {
-    new (styles: (string | CSSStyleSheet)[]): StyleStrategy;
-};
-
-// @public
-export function declarativeTemplate(callbacks?: TemplateLifecycleCallbacks): FASTElementTemplateResolver;
-
-// @public
-export interface DefaultCachedPath extends CachedPathCommon {
-    // (undocumented)
-    type: "default";
-}
-
-// @public
-export interface DOMPolicy {
-    createHTML(value: string): string;
-    // Warning: (ae-forgotten-export) The symbol "DOMAspect" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-forgotten-export) The symbol "DOMSink" needs to be exported by the entry point index.d.ts
-    protect(tagName: string | null, aspect: DOMAspect, aspectName: string, sink: DOMSink): DOMSink;
-}
-
-// @public
-export class ElementStyles {
-    constructor(styles: ReadonlyArray<ComposableStyles>);
-    // @internal (undocumented)
-    addStylesTo(target: StyleTarget): void;
-    // @internal (undocumented)
-    isAttachedTo(target: StyleTarget): boolean;
-    static normalize(styles: ComposableStyles | ComposableStyles[] | undefined): ElementStyles | undefined;
-    // @internal (undocumented)
-    removeStylesFrom(target: StyleTarget): void;
-    static setDefaultStrategy(Strategy: ConstructibleStyleStrategy): void;
-    get strategy(): StyleStrategy;
-    // (undocumented)
-    readonly styles: ReadonlyArray<ComposableStyles>;
-    static readonly supportsAdoptedStyleSheets: boolean;
-    withStrategy(Strategy: ConstructibleStyleStrategy): this;
-}
-
-// Warning: (ae-forgotten-export) The symbol "View" needs to be exported by the entry point index.d.ts
-//
-// @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;
-    // Warning: (ae-forgotten-export) The symbol "SourceLifetime" needs to be exported by the entry point index.d.ts
-    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 interface EventCachedPath extends CachedPathCommon {
-    // (undocumented)
-    type: "event";
-}
-
-// @public
-export class FASTElementDefinition<TType extends Constructable<HTMLElement> = Constructable<HTMLElement>> {
-    readonly attributeLookup: Record<string, AttributeDefinition>;
-    readonly attributes: ReadonlyArray<AttributeDefinition>;
-    static compose<TType extends Constructable<HTMLElement> = Constructable<HTMLElement>>(type: TType, nameOrDef?: string | PartialFASTElementDefinition<TType>): Promise<FASTElementDefinition<TType>>;
-    define(registry?: CustomElementRegistry, extensions?: FASTElementExtension[]): this;
-    readonly elementOptions: ElementDefinitionOptions;
-    static readonly getByType: (key: Function) => FASTElementDefinition<Constructable<HTMLElement>> | undefined;
-    static readonly getForInstance: (object: any) => FASTElementDefinition<Constructable<HTMLElement>> | undefined;
-    get isDefined(): boolean;
-    static isRegistered: Record<string, Function>;
-    readonly lifecycleCallbacks?: TemplateLifecycleCallbacks;
-    readonly name: string;
-    readonly propertyLookup: Record<string, AttributeDefinition>;
-    // @alpha
-    static register: (name: string, registry?: CustomElementRegistry) => Promise<Function>;
-    // @internal
-    static registerBaseType(type: Function): void;
-    readonly registry: CustomElementRegistry;
-    schema?: Schema;
-    shadowOptions?: ShadowRootOptions;
-    readonly styles?: ElementStyles;
-    template?: ElementViewTemplate<InstanceType<TType>>;
-    readonly type: TType;
-}
-
-// @public
-export type FASTElementExtension = (definition: FASTElementDefinition) => void;
-
-// @public
-export type FASTElementTemplateResolver<TType extends Constructable<HTMLElement> = Constructable<HTMLElement>> = (definition: FASTElementDefinition<TType>) => ElementViewTemplate<InstanceType<TType>> | Promise<ElementViewTemplate<InstanceType<TType>>>;
-
-// @public
-export interface HTMLTemplateCompilationResult<TSource = any, TParent = any> {
-    createView(hostBindingTarget?: Element): HTMLView<TSource, TParent>;
-    // Warning: (ae-forgotten-export) The symbol "CompiledViewBehaviorFactory" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    readonly factories: CompiledViewBehaviorFactory[];
-}
-
-// Warning: (ae-forgotten-export) The symbol "DefaultExecutionContext" needs to be exported by the entry point index.d.ts
-// Warning: (ae-forgotten-export) The symbol "SyntheticView" needs to be exported by the entry point index.d.ts
-// Warning: (ae-forgotten-export) The symbol "ExecutionContext" needs to be exported by the entry point index.d.ts
-//
-// @public
-export class HTMLView<TSource = any, TParent = any> extends DefaultExecutionContext<TParent> implements ElementView<TSource, TParent>, SyntheticView<TSource, TParent>, ExecutionContext<TParent> {
-    constructor(fragment: DocumentFragment, factories: ReadonlyArray<CompiledViewBehaviorFactory>, targets: ViewBehaviorTargets);
-    appendTo(node: Node): void;
-    bind(source: TSource, context?: ExecutionContext<TParent>): void;
-    context: ExecutionContext<TParent>;
-    dispose(): void;
-    static disposeContiguousBatch(views: SyntheticView[]): void;
-    firstChild: Node;
-    insertBefore(node: Node): void;
-    isBound: boolean;
-    isHydrated: Promise<boolean>;
-    isPrerendered: Promise<boolean>;
-    lastChild: Node;
-    // (undocumented)
-    onUnbind(behavior: {
-        unbind(controller: ViewController<TSource, TParent>): void;
-    }): void;
-    remove(): void;
-    // @internal
-    _skipAttrUpdates: boolean;
-    source: TSource | null;
-    readonly sourceLifetime: SourceLifetime;
-    // Warning: (ae-forgotten-export) The symbol "ViewBehaviorTargets" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    readonly targets: ViewBehaviorTargets;
-    unbind(): void;
-}
-
-// @public
-export interface JSONSchema extends JSONSchemaCommon {
-    // (undocumented)
-    $defs?: Record<string, JSONSchemaDefinition>;
-    // (undocumented)
-    $id: string;
-    // (undocumented)
-    $schema: string;
-}
-
-// @public
-export interface JSONSchemaCommon {
-    $observe?: boolean;
-    // (undocumented)
-    $ref?: string;
-    // (undocumented)
-    anyOf?: Array<any>;
-    // (undocumented)
-    items?: any;
-    // (undocumented)
-    properties?: any;
-    // (undocumented)
-    type?: string;
-}
-
-// @public
-export interface JSONSchemaDefinition extends JSONSchemaCommon {
-    // (undocumented)
-    $fast_context: string;
-    // (undocumented)
-    $fast_parent_contexts: Array<string>;
-}
-
-// @public
-export interface PartialFASTElementDefinition<TType extends Constructable<HTMLElement> = Constructable<HTMLElement>> {
-    readonly attributes?: (AttributeConfiguration | string)[];
-    readonly elementOptions?: ElementDefinitionOptions;
-    readonly lifecycleCallbacks?: TemplateLifecycleCallbacks;
-    readonly name: string;
-    readonly registry?: CustomElementRegistry;
-    readonly schema?: Schema;
-    readonly shadowOptions?: Partial<ShadowRootOptions> | null;
-    readonly styles?: ComposableStyles | ComposableStyles[];
-    readonly template?: ElementViewTemplate<InstanceType<TType>> | FASTElementTemplateResolver<TType>;
-}
-
-// @public
-export interface RegisterPathConfig {
-    // (undocumented)
-    childrenMap: ChildrenMap | null;
-    // (undocumented)
-    pathConfig: CachedPath;
-    // (undocumented)
-    rootPropertyName: string;
-}
-
-// @public
-export interface RepeatCachedPath extends CachedPathCommon {
-    // (undocumented)
-    type: "repeat";
-}
-
-// @public
-export interface ResolvedStringsAndValues {
-    // (undocumented)
-    strings: Array<string>;
-    // (undocumented)
-    values: Array<any>;
-}
-
-// @public
-export class Schema {
-    constructor(name: string);
-    addPath(config: RegisterPathConfig): void;
-    getRootProperties(): IterableIterator<string>;
-    getSchema(rootPropertyName: string): JSONSchema | null;
-}
-
-// @public
-export const schemaRegistry: CachedPathMap;
-
-// @public
-export interface ShadowRootOptions extends ShadowRootInit {
-    // @beta
-    registry?: CustomElementRegistry;
-}
-
-// @public
-export interface StyleStrategy {
-    addStylesTo(target: StyleTarget): void;
-    removeStylesFrom(target: StyleTarget): void;
-}
-
-// @public
-export interface StyleTarget extends Pick<Node, "getRootNode"> {
-    adoptedStyleSheets?: CSSStyleSheet[];
-    append(styles: HTMLStyleElement): void;
-    querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>;
-    removeChild(styles: HTMLStyleElement): void;
-}
-
-// @public
-export interface SyntheticViewTemplate<TSource = any, TParent = any> {
-    create(): SyntheticView<TSource, TParent>;
-    inline(): CaptureType;
-}
-
-// @public
-export interface TemplateLifecycleCallbacks {
-    elementDidDefine?(name: string): void;
-    elementDidHydrate?(source: HTMLElement): void;
-    elementDidRegister?(name: string): void;
-    elementWillHydrate?(source: HTMLElement): void;
-    templateDidUpdate?(name: string): void;
-    templateWillUpdate?(name: string): void;
-}
-
-// @public
-export class TemplateParser {
-    createTemplate(strings: Array<string>, values: Array<any>): ViewTemplate<any, any>;
-    parse(innerHTML: string, schema: Schema): ResolvedStringsAndValues;
-}
-
-// Warning: (ae-forgotten-export) The symbol "Expression" needs to be exported by the entry point index.d.ts
-// Warning: (ae-forgotten-export) The symbol "Binding" needs to be exported by the entry point index.d.ts
-// Warning: (ae-forgotten-export) The symbol "HTMLDirective" needs to be exported by the entry point index.d.ts
-//
-// @public
-export type TemplateValue<TSource, TParent = any> = Expression<TSource, any, TParent> | Binding<TSource, any, TParent> | HTMLDirective | CaptureType;
-
-// @public
-export interface ValueConverter {
-    fromView(value: any): any;
-    toView(value: any): any;
-}
-
-// @public
-export interface ViewBehavior<TSource = any, TParent = any> {
-    bind(controller: ViewController<TSource, TParent>): void;
-}
-
-// @public
-export interface ViewBehaviorFactory {
-    createBehavior(): ViewBehavior;
-    id?: string;
-    policy?: DOMPolicy;
-    targetNodeId?: string;
-    targetTagName?: string | null;
-}
-
-// @public
-export class ViewTemplate<TSource = any, TParent = any> implements ElementViewTemplate<TSource, TParent>, SyntheticViewTemplate<TSource, TParent> {
-    constructor(html: string | HTMLTemplateElement, factories?: Record<string, ViewBehaviorFactory>, policy?: DOMPolicy | undefined);
-    // @internal (undocumented)
-    compile(): HTMLTemplateCompilationResult<TSource, TParent>;
-    create(hostBindingTarget?: Element): HTMLView<TSource, TParent>;
-    static create<TSource = any, TParent = any>(strings: string[], values: TemplateValue<TSource, TParent>[], policy?: DOMPolicy): ViewTemplate<TSource, TParent>;
-    readonly factories: Record<string, ViewBehaviorFactory>;
-    readonly html: string | HTMLTemplateElement;
-    inline(): CaptureType;
-    render(source: TSource, host: Node, hostBindingTarget?: Element): HTMLView<TSource, TParent>;
-    withPolicy(policy: DOMPolicy): this;
-}
-
-// Warnings were encountered during analysis:
-//
-// dist/dts/templating/view.d.ts:45:9 - (ae-forgotten-export) The symbol "ViewController" needs to be exported by the entry point index.d.ts
-
-// (No @packageDocumentation comment for this package)
-
-```