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

package/CHANGELOG.md

@@ -1,9 +1,234 @@
 # Change Log - @microsoft/fast-router
 
-This log was last generated on Wed, 22 Jun 2022 20:17:50 GMT and should not be manually modified.
+<!-- This log was last generated on Tue, 27 Jan 2026 17:28:54 GMT and should not be manually modified. -->
 
 <!-- Start content -->
 
+## 1.0.0-alpha.30
+
+Tue, 27 Jan 2026 17:28:54 GMT
+
+### Changes
+
+- chore: hoist devDependencies (863023+radium-v@users.noreply.github.com)
+- Bump @microsoft/fast-element to v2.9.2
+
+## 1.0.0-alpha.29
+
+Wed, 11 Dec 2024 19:53:31 GMT
+
+### Changes
+
+- Change the router to use peerDependency for fast-element (7559015+janechu@users.noreply.github.com)
+- Bump @microsoft/fast-element to v2.0.1
+
+## 1.0.0-alpha.28
+
+Mon, 19 Aug 2024 22:04:19 GMT
+
+### Changes
+
+- Fix CodeQL issues (7559015+janechu@users.noreply.github.com)
+- Bump @microsoft/fast-element to v2.0.0
+
+## 1.0.0-alpha.27
+
+Thu, 20 Jun 2024 17:00:56 GMT
+
+### Changes
+
+- fix: remove link handler in disconnect (1222863+xuwaters@users.noreply.github.com)
+
+## 1.0.0-alpha.26
+
+Fri, 18 Aug 2023 00:04:39 GMT
+
+### Changes
+
+- update fast-element export paths to include extensions (chhol@microsoft.com)
+- Bump @microsoft/fast-element to v2.0.0-beta.26
+
+## 1.0.0-alpha.25
+
+Sat, 12 Aug 2023 00:26:36 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.25
+
+## 1.0.0-alpha.24
+
+Fri, 16 Jun 2023 18:17:13 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.24
+
+## 1.0.0-alpha.23
+
+Tue, 28 Mar 2023 22:14:10 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.23
+
+## 1.0.0-alpha.22
+
+Sat, 11 Mar 2023 00:09:49 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.22
+
+## 1.0.0-alpha.21
+
+Tue, 14 Feb 2023 04:02:36 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.21
+
+## 1.0.0-alpha.20
+
+Wed, 11 Jan 2023 22:07:44 GMT
+
+### Changes
+
+- fix: router cannot render component and has missing types (roeisenb@microsoft.com)
+- fix(fast-router): update to use html.partial (roeisenb@microsoft.com)
+- Bump @microsoft/fast-element to v2.0.0-beta.20
+
+## 1.0.0-alpha.19
+
+Fri, 02 Dec 2022 01:18:22 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.19
+
+## 1.0.0-alpha.18
+
+Tue, 15 Nov 2022 02:40:35 GMT
+
+### Changes
+
+- feat: add new DOM Policy protection throughout (roeisenb@microsoft.com)
+- Bump @microsoft/fast-element to v2.0.0-beta.18
+
+## 1.0.0-alpha.17
+
+Tue, 01 Nov 2022 23:26:26 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.17
+
+## 1.0.0-alpha.16
+
+Fri, 28 Oct 2022 20:44:44 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.16
+
+## 1.0.0-alpha.15
+
+Tue, 25 Oct 2022 20:24:32 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.15
+
+## 1.0.0-alpha.14
+
+Fri, 14 Oct 2022 18:26:11 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.14
+
+## 1.0.0-alpha.13
+
+Mon, 10 Oct 2022 20:28:02 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.13
+
+## 1.0.0-alpha.12
+
+Thu, 06 Oct 2022 23:21:20 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.12
+
+## 1.0.0-alpha.11
+
+Wed, 05 Oct 2022 23:26:01 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.11
+
+## 1.0.0-alpha.10
+
+Mon, 03 Oct 2022 23:44:38 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.10
+
+## 1.0.0-alpha.9
+
+Wed, 28 Sep 2022 20:45:51 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.9
+
+## 1.0.0-alpha.8
+
+Tue, 27 Sep 2022 22:31:52 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.8
+
+## 1.0.0-alpha.7
+
+Fri, 23 Sep 2022 22:53:27 GMT
+
+### Changes
+
+- fix: update router to use the new behavior API (roeisenb@microsoft.com)
+- Bump @microsoft/fast-element to v2.0.0-beta.7
+
+## 1.0.0-alpha.6
+
+Thu, 01 Sep 2022 21:53:34 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.6
+
+## 1.0.0-alpha.5
+
+Thu, 18 Aug 2022 20:46:10 GMT
+
+### Changes
+
+- Bump @microsoft/fast-element to v2.0.0-beta.5
+
+## 1.0.0-alpha.4
+
+Mon, 18 Jul 2022 21:10:01 GMT
+
+### Changes
+
+- refactor: reduce duplication in style normalization code scenarios (roeisenb@microsoft.com)
+- Bump @microsoft/fast-element to v2.0.0-beta.4
+
 ## 1.0.0-alpha.3
 
 Wed, 22 Jun 2022 20:17:50 GMT

package/README.md

@@ -6,16 +6,12 @@ The `@microsoft/fast-router` package contains a history-based navigation and rou
 
 ### From NPM
 
-To install the `fast-router` library, use either `npm` or `yarn` as follows:
+To install the `fast-router` library using `npm`:
 
 ```shell
 npm install --save @microsoft/fast-router
 ```
 
-```shell
-yarn add @microsoft/fast-router
-```
-
 Within your JavaScript or TypeScript code, you can then import library APIs like this:
 
 ```ts

package/dist/dts/contributors.d.ts

@@ -1,10 +1,9 @@
-import { AddViewBehaviorFactory, Behavior, HTMLDirective, ViewBehaviorTargets } from "@microsoft/fast-element";
+import { AddViewBehaviorFactory, ViewBehavior, ViewBehaviorFactory, ViewController } from "@microsoft/fast-element";
 import { NavigationCommitPhaseHook, NavigationPhaseHook, NavigationPhaseName } from "./phases.js";
-import { RouterExecutionContext } from "./view.js";
 /**
  * @beta
  */
-export declare type NavigationContributor<TSettings = any> = Partial<Record<Exclude<NavigationPhaseName, "commit">, NavigationPhaseHook<TSettings>>> & {
+export type NavigationContributor<TSettings = any> = Partial<Record<Exclude<NavigationPhaseName, "commit">, NavigationPhaseHook<TSettings>>> & {
     commit?: NavigationCommitPhaseHook<TSettings>;
 };
 /**
@@ -14,24 +13,23 @@ export declare function isNavigationPhaseContributor<T extends NavigationPhaseNa
 /**
  * @beta
  */
-export declare type ContributorOptions = {
+export type ContributorOptions = {
     lifecycle?: boolean;
     parameters?: boolean;
 };
-declare class NavigationContributorDirective implements HTMLDirective {
-    private options;
-    id: string;
-    nodeId: string;
+declare class NavigationContributorDirective implements ViewBehaviorFactory {
+    readonly options: Required<ContributorOptions>;
+    targetNodeId: string;
     constructor(options: Required<ContributorOptions>);
     createHTML(add: AddViewBehaviorFactory): string;
-    createBehavior(targets: ViewBehaviorTargets): NavigationContributorBehavior;
+    createBehavior(): NavigationContributorBehavior;
 }
-declare class NavigationContributorBehavior implements Behavior {
-    private contributor;
-    private options;
+declare class NavigationContributorBehavior implements ViewBehavior {
+    private directive;
     private router;
-    constructor(contributor: HTMLElement & NavigationContributor, options: Required<ContributorOptions>);
-    bind(source: unknown, context: RouterExecutionContext): void;
+    private contributor;
+    constructor(directive: NavigationContributorDirective);
+    bind(controller: ViewController): void;
     unbind(source: unknown): void;
 }
 /**

package/dist/dts/phases.d.ts

@@ -3,19 +3,19 @@ import { Router } from "./router.js";
 /**
  * @beta
  */
-export declare type NavigationPhaseName = "navigate" | "leave" | "construct" | "enter" | "commit";
+export type NavigationPhaseName = "navigate" | "leave" | "construct" | "enter" | "commit";
 /**
  * @beta
  */
-export declare type NavigationPhaseHook<TSettings = any> = (phase: NavigationPhase<TSettings>) => Promise<any> | any;
+export type NavigationPhaseHook<TSettings = any> = (phase: NavigationPhase<TSettings>) => Promise<any> | any;
 /**
  * @beta
  */
-export declare type NavigationCommitPhaseHook<TSettings = any> = (phase: NavigationCommitPhase<TSettings>) => Promise<any> | any;
+export type NavigationCommitPhaseHook<TSettings = any> = (phase: NavigationCommitPhase<TSettings>) => Promise<any> | any;
 /**
  * @beta
  */
-export declare type NavigationPhaseFollowupAction = () => Promise<any> | any;
+export type NavigationPhaseFollowupAction = () => Promise<any> | any;
 /**
  * @beta
  */
@@ -33,5 +33,5 @@ export interface NavigationPhase<TSettings = any> {
  * @beta
  */
 export interface NavigationCommitPhase<TSettings = any> extends Omit<NavigationPhase<TSettings>, "cancel" | "canceled" | "onCancel"> {
-    setTitle(title: string): any;
+    setTitle(title: string): void;
 }

package/dist/dts/query-string.d.ts

@@ -10,7 +10,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): string;
+    build(params: Record<string, string>, traditional?: boolean): string;
     /**
      * Separate the query string from the path and returns the two parts.
      * @param path - The path to separate.

package/dist/dts/recognizer.d.ts

@@ -2,7 +2,16 @@ import { Route } from "./navigation.js";
 /**
  * @beta
  */
-export declare type RouteParameterConverter = (value: string | undefined) => any | Promise<any>;
+export interface RouteParameterConverterContext<TSettings = any> {
+    readonly endpoint: Endpoint<TSettings>;
+    readonly params: Readonly<Record<string, string | undefined>>;
+    readonly typedParams: Record<string, any>;
+    readonly queryParams: Record<string, string>;
+}
+/**
+ * @beta
+ */
+export type RouteParameterConverter = (name: string, value: string | undefined, context: RouteParameterConverterContext) => any | Promise<any>;
 /**
  * @beta
  */

package/dist/dts/router.d.ts

@@ -32,8 +32,8 @@ declare const routerProperty = "$router";
 export interface RouterElement extends HTMLElement {
     readonly [routerProperty]: Router;
     config: RouterConfiguration | null;
-    connectedCallback(): any;
-    disconnectedCallback(): any;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
 }
 /**
  * @beta

package/dist/dts/routes.d.ts

@@ -11,127 +11,127 @@ export declare const childRouteParameter = "fast-child-route";
 /**
  * @beta
  */
-export declare type SupportsSettings<TSettings = any> = {
+export type SupportsSettings<TSettings = any> = {
     settings?: TSettings;
 };
 /**
  * @beta
  */
-export declare type PathedRouteDefinition<TSettings = any> = SupportsSettings<TSettings> & Route;
+export type PathedRouteDefinition<TSettings = any> = SupportsSettings<TSettings> & Route;
 /**
  * @beta
  */
-export declare type IgnorableRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings>;
+export type IgnorableRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings>;
 /**
  * @beta
  */
-export declare type LayoutAndTransitionRouteDefinition = {
+export type LayoutAndTransitionRouteDefinition = {
     layout?: Layout | ViewTemplate;
     transition?: Transition;
 };
 /**
  * @beta
  */
-export declare type RedirectRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & {
+export type RedirectRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & {
     redirect: string;
 };
 /**
  * @beta
  */
-export declare type HasTitle = {
+export type HasTitle = {
     title?: string;
 };
 /**
  * @beta
  */
-export declare type NavigableRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & LayoutAndTransitionRouteDefinition & HasTitle & {
+export type NavigableRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & LayoutAndTransitionRouteDefinition & HasTitle & {
     childRouters?: boolean;
 };
 /**
  * @beta
  */
-export declare type FASTElementConstructor = new () => FASTElement;
+export type FASTElementConstructor = new () => FASTElement;
 /**
  * @beta
  */
-export declare type HasElement = {
+export type HasElement = {
     element: string | FASTElementConstructor | HTMLElement | (() => Promise<string | FASTElementConstructor | HTMLElement>);
 };
 /**
  * @beta
  */
-export declare type ElementFallbackRouteDefinition<TSettings = any> = LayoutAndTransitionRouteDefinition & HasElement & SupportsSettings<TSettings> & HasTitle;
+export type ElementFallbackRouteDefinition<TSettings = any> = LayoutAndTransitionRouteDefinition & HasElement & SupportsSettings<TSettings> & HasTitle;
 /**
  * @beta
  */
-export declare type ElementRouteDefinition<TSettings = any> = NavigableRouteDefinition<TSettings> & HasElement;
+export type ElementRouteDefinition<TSettings = any> = NavigableRouteDefinition<TSettings> & HasElement;
 /**
  * @beta
  */
-export declare type HasTemplate = {
+export type HasTemplate = {
     template: ViewTemplate | (() => Promise<ViewTemplate>);
 };
 /**
  * @beta
  */
-export declare type TemplateFallbackRouteDefinition<TSettings = any> = LayoutAndTransitionRouteDefinition & HasTemplate & SupportsSettings<TSettings> & HasTitle;
+export type TemplateFallbackRouteDefinition<TSettings = any> = LayoutAndTransitionRouteDefinition & HasTemplate & SupportsSettings<TSettings> & HasTitle;
 /**
  * @beta
  */
-export declare type TemplateRouteDefinition<TSettings = any> = NavigableRouteDefinition<TSettings> & HasTemplate;
+export type TemplateRouteDefinition<TSettings = any> = NavigableRouteDefinition<TSettings> & HasTemplate;
 /**
  * @beta
  */
-export declare type HasCommand = {
+export type HasCommand = {
     command: NavigationCommand;
 };
 /**
  * @beta
  */
-export declare type CommandRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & HasCommand & HasTitle;
+export type CommandRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & HasCommand & HasTitle;
 /**
  * @beta
  */
-export declare type CommandFallbackRouteDefinition<TSettings = any> = HasCommand & SupportsSettings<TSettings> & HasTitle;
+export type CommandFallbackRouteDefinition<TSettings = any> = HasCommand & SupportsSettings<TSettings> & HasTitle;
 /**
  * @beta
  */
-export declare type FallbackRouteDefinition<TSettings = any> = ElementFallbackRouteDefinition<TSettings> | TemplateFallbackRouteDefinition<TSettings> | Pick<RedirectRouteDefinition<TSettings>, "redirect"> | CommandFallbackRouteDefinition<TSettings>;
+export type FallbackRouteDefinition<TSettings = any> = ElementFallbackRouteDefinition<TSettings> | TemplateFallbackRouteDefinition<TSettings> | Pick<RedirectRouteDefinition<TSettings>, "redirect"> | CommandFallbackRouteDefinition<TSettings>;
 /**
  * @beta
  */
-export declare type DefinitionCallback = () => Promise<FallbackRouteDefinition> | FallbackRouteDefinition;
+export type DefinitionCallback = () => Promise<FallbackRouteDefinition> | FallbackRouteDefinition;
 /**
  * @beta
  */
-export declare type RenderableRouteDefinition<TSettings = any> = ElementRouteDefinition<TSettings> | TemplateRouteDefinition<TSettings>;
+export type RenderableRouteDefinition<TSettings = any> = ElementRouteDefinition<TSettings> | TemplateRouteDefinition<TSettings>;
 /**
  * @beta
  */
-export declare type MappableRouteDefinition<TSettings = any> = RenderableRouteDefinition<TSettings> | RedirectRouteDefinition<TSettings> | CommandRouteDefinition<TSettings> | ParentRouteDefinition<TSettings>;
+export type MappableRouteDefinition<TSettings = any> = RenderableRouteDefinition<TSettings> | RedirectRouteDefinition<TSettings> | CommandRouteDefinition<TSettings> | ParentRouteDefinition<TSettings>;
 /**
  * @beta
  */
-export declare type ParentRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & LayoutAndTransitionRouteDefinition & {
+export type ParentRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & LayoutAndTransitionRouteDefinition & {
     children: MappableRouteDefinition<TSettings>[];
 };
 /**
  * @beta
  */
-export declare type RouteMatch<TSettings = any> = {
+export type RouteMatch<TSettings = any> = {
     route: RecognizedRoute<TSettings>;
     command: NavigationCommand;
 };
 /**
  * @beta
  */
-export declare type ConverterObject = {
+export type RouteParameterConverterObject = {
     convert: RouteParameterConverter;
 };
 /**
  * @beta
  */
-export declare type ParameterConverter = RouteParameterConverter | ConverterObject | Constructable<ConverterObject>;
+export type ParameterConverter = RouteParameterConverter | RouteParameterConverterObject | Constructable<RouteParameterConverterObject>;
 /**
  * @beta
  */

package/dist/dts/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.24.2"
+      "packageVersion": "7.47.0"
     }
   ]
 }

package/dist/dts/view.d.ts

@@ -3,20 +3,15 @@ import { Router } from "./router.js";
 /**
  * @beta
  */
-export declare type RouterExecutionContext = ExecutionContext & {
-    router: Router;
+export type RouterExecutionContext = ExecutionContext & {
+    router?: Router;
 };
-/**
- * @beta
- */
-export declare const RouterExecutionContext: Readonly<{
-    create(router: Router): any;
-}>;
 /**
  * @beta
  */
 export interface RouteView {
-    bind(allTypedParams: Readonly<Record<string, any>>, context: RouterExecutionContext): void;
+    context: RouterExecutionContext;
+    bind(allTypedParams: Readonly<Record<string, any>>): void;
     appendTo(host: HTMLElement): void;
     dispose(): void;
 }
@@ -48,7 +43,7 @@ export declare class FASTElementLayout implements Layout {
     private readonly template;
     private runBeforeCommit;
     private styles;
-    constructor(template?: ViewTemplate | null, styles?: ComposableStyles | ComposableStyles[] | null, runBeforeCommit?: boolean);
+    constructor(template?: ViewTemplate | null, styles?: ComposableStyles | ComposableStyles[] | undefined, runBeforeCommit?: boolean);
     beforeCommit(routerElement: HTMLElement): Promise<void>;
     afterCommit(routerElement: HTMLElement): Promise<void>;
     private apply;

package/dist/esm/commands.js

@@ -45,16 +45,17 @@ export class Redirect {
         });
     }
 }
-function factoryFromElementName(name) {
-    return html `<${name} ${navigationContributor()}></${name}>`;
+function factoryFromElementName(tagName) {
+    const tag = html.partial(tagName);
+    return html `<${tag} ${navigationContributor()}></${tag}>`;
 }
 function factoryFromElementInstance(element) {
     const fragment = document.createDocumentFragment();
     fragment.appendChild(element);
     const factory = navigationContributor();
-    factory.nodeId = "h";
+    factory.targetNodeId = "h";
     const view = new HTMLView(fragment, [factory], {
-        [factory.nodeId]: element,
+        [factory.targetNodeId]: element,
     });
     return {
         create() {
@@ -160,10 +161,12 @@ export class Render {
                     }
                 }
                 else if (element instanceof HTMLElement) {
-                    definition.factory = factory = factoryFromElementInstance(element);
+                    definition.factory = factory =
+                        factoryFromElementInstance(element);
                 }
                 else {
-                    definition.factory = factory = factoryFromElementName(element);
+                    definition.factory = factory =
+                        factoryFromElementName(element);
                 }
                 return factory.create();
             });

package/dist/esm/contributors.js

@@ -17,34 +17,38 @@ class NavigationContributorDirective {
     createHTML(add) {
         return Markup.attribute(add(this));
     }
-    createBehavior(targets) {
-        return new NavigationContributorBehavior(targets[this.nodeId], this.options);
+    createBehavior() {
+        return new NavigationContributorBehavior(this);
     }
 }
 HTMLDirective.define(NavigationContributorDirective);
 class NavigationContributorBehavior {
-    constructor(contributor, options) {
-        this.contributor = contributor;
-        this.options = options;
+    constructor(directive) {
+        this.directive = directive;
         this.router = null;
     }
-    bind(source, context) {
-        if (this.options.lifecycle) {
-            this.router = context.router || Router.find(this.contributor);
-            this.router.addContributor(this.contributor);
+    bind(controller) {
+        var _a;
+        const context = controller.context;
+        const options = this.directive.options;
+        this.contributor = controller.targets[this.directive.targetNodeId];
+        if (options.lifecycle) {
+            this.router = (_a = context.router) !== null && _a !== void 0 ? _a : Router.find(this.contributor);
+            if (this.router) {
+                this.router.addContributor(this.contributor);
+                controller.onUnbind(this);
+            }
         }
-        if (this.options.parameters) {
+        if (options.parameters) {
             const contributor = this.contributor;
-            const routeParams = source;
+            const routeParams = controller.source;
             for (const key in routeParams) {
                 contributor[key] = routeParams[key];
             }
         }
     }
     unbind(source) {
-        if (this.router !== null) {
-            this.router.removeContributor(this.contributor);
-        }
+        this.router.removeContributor(this.contributor);
     }
 }
 /**

package/dist/esm/links.js

@@ -16,7 +16,7 @@ export class DefaultLinkHandler {
         window.addEventListener("click", this.handler, true);
     }
     disconnect() {
-        window.removeEventListener("click", this.handler);
+        window.removeEventListener("click", this.handler, true);
     }
     getEventInfo(event) {
         const info = {