@microsoft/fast-router 0.4.2 → 1.0.0-alpha.3

package/dist/fast-router.d.ts

@@ -1,27 +1,27 @@
+import { AddViewBehaviorFactory } from '@microsoft/fast-element';
+import { Behavior } from '@microsoft/fast-element';
 import { ComposableStyles } from '@microsoft/fast-element';
 import { Constructable } from '@microsoft/fast-element';
 import { ExecutionContext } from '@microsoft/fast-element';
 import { FASTElement } from '@microsoft/fast-element';
 import { HTMLDirective } from '@microsoft/fast-element';
+import { ViewBehaviorTargets } from '@microsoft/fast-element';
 import { ViewTemplate } from '@microsoft/fast-element';
 
-/**
- * @internal
- */
-export declare const childRouteParameter = "fast-child-route";
+/* Excluded from this release type: childRouteParameter */
 
 /**
- * @alpha
+ * @beta
  */
 export declare type CommandFallbackRouteDefinition<TSettings = any> = HasCommand & SupportsSettings<TSettings> & HasTitle;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type CommandRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & HasCommand & HasTitle;
 
 /**
- * @alpha
+ * @beta
  */
 export declare class ConfigurableRoute implements Route {
     readonly path: string;
@@ -31,7 +31,7 @@ export declare class ConfigurableRoute implements Route {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type ContributorOptions = {
     lifecycle?: boolean;
@@ -39,14 +39,14 @@ export declare type ContributorOptions = {
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare type ConverterObject = {
     convert: RouteParameterConverter;
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare class DefaultLinkHandler implements LinkHandler {
     private handler;
@@ -58,7 +58,7 @@ export declare class DefaultLinkHandler implements LinkHandler {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare class DefaultNavigationProcess<TSettings> {
     private phases;
@@ -67,7 +67,7 @@ export declare class DefaultNavigationProcess<TSettings> {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare class DefaultNavigationQueue implements NavigationQueue, NavigationHandler {
     private queue;
@@ -82,7 +82,7 @@ export declare class DefaultNavigationQueue implements NavigationQueue, Navigati
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare class DefaultRouter implements Router {
     readonly host: HTMLElement;
@@ -125,7 +125,7 @@ export declare class DefaultRouter implements Router {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare class DefaultRouteRecognizer<TSettings> implements RouteRecognizer<TSettings> {
     private names;
@@ -156,22 +156,22 @@ export declare class DefaultRouteRecognizer<TSettings> implements RouteRecognize
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type DefinitionCallback = () => Promise<FallbackRouteDefinition> | FallbackRouteDefinition;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type ElementFallbackRouteDefinition<TSettings = any> = LayoutAndTransitionRouteDefinition & HasElement & SupportsSettings<TSettings> & HasTitle;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type ElementRouteDefinition<TSettings = any> = NavigableRouteDefinition<TSettings> & HasElement;
 
 /**
- * @alpha
+ * @beta
  */
 export declare class Endpoint<TSettings = any> {
     readonly route: ConfigurableRoute;
@@ -183,17 +183,17 @@ export declare class Endpoint<TSettings = any> {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type FallbackRouteDefinition<TSettings = any> = ElementFallbackRouteDefinition<TSettings> | TemplateFallbackRouteDefinition<TSettings> | Pick<RedirectRouteDefinition<TSettings>, "redirect"> | CommandFallbackRouteDefinition<TSettings>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type FASTElementConstructor = new () => FASTElement;
 
 /**
- * @alpha
+ * @beta
  */
 export declare class FASTElementLayout implements Layout {
     private readonly template;
@@ -206,7 +206,7 @@ export declare class FASTElementLayout implements Layout {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare class FASTRouter extends FASTRouter_base {
 }
@@ -214,40 +214,40 @@ export declare class FASTRouter extends FASTRouter_base {
 declare const FASTRouter_base: new () => FASTElement & RouterElement;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type HasCommand = {
     command: NavigationCommand;
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare type HasElement = {
     element: string | FASTElementConstructor | HTMLElement | (() => Promise<string | FASTElementConstructor | HTMLElement>);
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare type HasTemplate = {
     template: ViewTemplate | (() => Promise<ViewTemplate>);
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare type HasTitle = {
     title?: string;
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare type IgnorableRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare class Ignore implements NavigationCommand {
     createContributor(): Promise<{
@@ -256,17 +256,17 @@ export declare class Ignore implements NavigationCommand {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare function isFASTElementHost(host: HTMLElement): host is HTMLElement & FASTElement;
 
 /**
- * @alpha
+ * @beta
  */
 export declare function isNavigationPhaseContributor<T extends NavigationPhaseName>(object: any, phase: T): object is Record<T, NavigationPhaseHook>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface Layout {
     beforeCommit(routerElement: HTMLElement): Promise<void>;
@@ -274,14 +274,14 @@ export declare interface Layout {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare const Layout: Readonly<{
     default: Readonly<Layout>;
 }>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type LayoutAndTransitionRouteDefinition = {
     layout?: Layout | ViewTemplate;
@@ -289,7 +289,7 @@ export declare type LayoutAndTransitionRouteDefinition = {
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface LinkHandler {
     connect(): void;
@@ -297,57 +297,75 @@ export declare interface LinkHandler {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type MappableRouteDefinition<TSettings = any> = RenderableRouteDefinition<TSettings> | RedirectRouteDefinition<TSettings> | CommandRouteDefinition<TSettings> | ParentRouteDefinition<TSettings>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigableRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & LayoutAndTransitionRouteDefinition & HasTitle & {
     childRouters?: boolean;
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface NavigationCommand {
     createContributor(router: Router, route: RecognizedRoute): Promise<NavigationContributor>;
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface NavigationCommitPhase<TSettings = any> extends Omit<NavigationPhase<TSettings>, "cancel" | "canceled" | "onCancel"> {
     setTitle(title: string): any;
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigationCommitPhaseHook<TSettings = any> = (phase: NavigationCommitPhase<TSettings>) => Promise<any> | any;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigationContributor<TSettings = any> = Partial<Record<Exclude<NavigationPhaseName, "commit">, NavigationPhaseHook<TSettings>>> & {
     commit?: NavigationCommitPhaseHook<TSettings>;
 };
 
 /**
- * @alpha
+ * @beta
  */
-export declare function navigationContributor(options?: ContributorOptions): HTMLDirective;
+export declare function navigationContributor(options?: ContributorOptions): NavigationContributorDirective;
+
+declare class NavigationContributorBehavior implements Behavior {
+    private contributor;
+    private options;
+    private router;
+    constructor(contributor: HTMLElement & NavigationContributor, options: Required<ContributorOptions>);
+    bind(source: unknown, context: RouterExecutionContext): void;
+    unbind(source: unknown): void;
+}
+
+declare class NavigationContributorDirective implements HTMLDirective {
+    private options;
+    id: string;
+    nodeId: string;
+    constructor(options: Required<ContributorOptions>);
+    createHTML(add: AddViewBehaviorFactory): string;
+    createBehavior(targets: ViewBehaviorTargets): NavigationContributorBehavior;
+}
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface NavigationHandler {
     enqueue(msg: NavigationMessage): void;
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare const NavigationHandler: Readonly<{
     register(handler: NavigationHandler): void;
@@ -355,7 +373,7 @@ export declare const NavigationHandler: Readonly<{
 }>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare class NavigationMessage {
     path: string;
@@ -363,7 +381,7 @@ export declare class NavigationMessage {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface NavigationPhase<TSettings = any> {
     readonly name: NavigationPhaseName;
@@ -377,12 +395,12 @@ export declare interface NavigationPhase<TSettings = any> {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigationPhaseFollowupAction = () => Promise<any> | any;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigationPhaseHook<TSettings = any> = (phase: NavigationPhase<TSettings>) => Promise<any> | any;
 
@@ -405,19 +423,19 @@ declare class NavigationPhaseImpl<TSettings = any> implements NavigationCommitPh
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigationPhaseName = "navigate" | "leave" | "construct" | "enter" | "commit";
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface NavigationProcess {
     run(router: Router, message: NavigationMessage): Promise<void>;
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface NavigationQueue {
     connect(): void;
@@ -426,24 +444,24 @@ export declare interface NavigationQueue {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type ParameterConverter = RouteParameterConverter | ConverterObject | Constructable<ConverterObject>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type ParentRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & LayoutAndTransitionRouteDefinition & {
     children: MappableRouteDefinition<TSettings>[];
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare type PathedRouteDefinition<TSettings = any> = SupportsSettings<TSettings> & Route;
 
 /**
- * @alpha
+ * @beta
  */
 export declare const QueryString: Readonly<{
     readonly current: string;
@@ -454,7 +472,7 @@ export declare const QueryString: Readonly<{
      * @param traditional - Boolean Use the old URI template standard (RFC6570)
      * @returns The generated query string, excluding leading '?'.
      */
-    build(params: Object, traditional?: boolean | undefined): string;
+    build(params: Object, traditional?: boolean): string;
     /**
      * Separate the query string from the path and returns the two parts.
      * @param path - The path to separate.
@@ -473,7 +491,7 @@ export declare const QueryString: Readonly<{
 }>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare class RecognizedRoute<TSettings = any> {
     readonly endpoint: Endpoint<TSettings>;
@@ -487,7 +505,7 @@ export declare class RecognizedRoute<TSettings = any> {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare class Redirect implements NavigationCommand {
     private redirect;
@@ -498,14 +516,14 @@ export declare class Redirect implements NavigationCommand {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type RedirectRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & {
     redirect: string;
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare class Render implements RenderCommand {
     private owner;
@@ -523,12 +541,12 @@ export declare class Render implements RenderCommand {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type RenderableRouteDefinition<TSettings = any> = ElementRouteDefinition<TSettings> | TemplateRouteDefinition<TSettings>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface RenderCommand extends NavigationCommand {
     layout: Layout;
@@ -547,7 +565,7 @@ declare class RenderContributor {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface RenderOperation {
     commit(): Promise<void>;
@@ -555,7 +573,7 @@ export declare interface RenderOperation {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface Route {
     readonly path: string;
@@ -564,7 +582,7 @@ export declare interface Route {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare const Route: Readonly<{
     path: Readonly<{
@@ -583,7 +601,7 @@ export declare const Route: Readonly<{
 }>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare class RouteCollection<TSettings = any> {
     private owner;
@@ -621,7 +639,7 @@ export declare class RouteCollection<TSettings = any> {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type RouteMatch<TSettings = any> = {
     route: RecognizedRoute<TSettings>;
@@ -629,12 +647,12 @@ export declare type RouteMatch<TSettings = any> = {
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare type RouteParameterConverter = (value: string | undefined) => any | Promise<any>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface Router<TSettings = any> {
     readonly level: number;
@@ -650,7 +668,7 @@ export declare interface Router<TSettings = any> {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare const Router: Readonly<{
     getOrCreateFor(element: HTMLElement): Router<any> | DefaultRouter;
@@ -662,7 +680,7 @@ export declare const Router: Readonly<{
 }>;
 
 /**
- * @alpha
+ * @beta
  */
 export declare abstract class RouterConfiguration<TSettings = any> {
     private isConfigured;
@@ -705,7 +723,7 @@ export declare abstract class RouterConfiguration<TSettings = any> {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface RouteRecognizer<TSettings> {
     add(routeOrRoutes: Route | readonly Route[], settings?: TSettings): void;
@@ -715,7 +733,7 @@ export declare interface RouteRecognizer<TSettings> {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface RouterElement extends HTMLElement {
     readonly [routerProperty]: Router;
@@ -725,14 +743,14 @@ export declare interface RouterElement extends HTMLElement {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type RouterExecutionContext = ExecutionContext & {
     router: Router;
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare const RouterExecutionContext: Readonly<{
     create(router: Router): any;
@@ -741,7 +759,7 @@ export declare const RouterExecutionContext: Readonly<{
 declare const routerProperty = "$router";
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface RouteView {
     bind(allTypedParams: Readonly<Record<string, any>>, context: RouterExecutionContext): void;
@@ -750,7 +768,7 @@ export declare interface RouteView {
 }
 
 /**
- * @alpha
+ * @beta
  */
 declare interface RoutingEventSink {
     onUnhandledNavigationMessage(router: Router, message: NavigationMessage): void;
@@ -761,24 +779,24 @@ declare interface RoutingEventSink {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare type SupportsSettings<TSettings = any> = {
     settings?: TSettings;
 };
 
 /**
- * @alpha
+ * @beta
  */
 export declare type TemplateFallbackRouteDefinition<TSettings = any> = LayoutAndTransitionRouteDefinition & HasTemplate & SupportsSettings<TSettings> & HasTitle;
 
 /**
- * @alpha
+ * @beta
  */
 export declare type TemplateRouteDefinition<TSettings = any> = NavigableRouteDefinition<TSettings> & HasTemplate;
 
 /**
- * @alpha
+ * @beta
  */
 declare interface TitleBuilder {
     joinTitles(parentTitle: string, childTitle: string): string;
@@ -786,7 +804,7 @@ declare interface TitleBuilder {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare interface Transition {
     begin(host: HTMLElement, prev: RouteView | null, next: RouteView): Promise<void>;
@@ -795,7 +813,7 @@ export declare interface Transition {
 }
 
 /**
- * @alpha
+ * @beta
  */
 export declare const Transition: Readonly<{
     default: Readonly<Transition>;