@microsoft/fast-router 0.4.1 → 1.0.0-alpha.2

package/.eslintrc.json

@@ -12,10 +12,6 @@
                 },
                 "extendDefaults": true
             }
-        ],
-        "import/extensions": [
-            "error",
-            "always"
         ]
     }
 }

package/CHANGELOG.json

@@ -2,7 +2,201 @@
   "name": "@microsoft/fast-router",
   "entries": [
     {
-      "date": "Tue, 03 May 2022 07:12:26 GMT",
+      "date": "Wed, 15 Jun 2022 17:41:10 GMT",
+      "tag": "@microsoft/fast-router_v1.0.0-alpha.2",
+      "version": "1.0.0-alpha.2",
+      "comments": {
+        "prerelease": [
+          {
+            "comment": "chore: fix package.json type fields",
+            "author": "roeisenb@microsoft.com",
+            "commit": "e86a638b9e84cbf36d950025889742944e68e512",
+            "package": "@microsoft/fast-router"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 01 Jun 2022 17:53:14 GMT",
+      "tag": "@microsoft/fast-router_v1.0.0-alpha.1",
+      "version": "1.0.0-alpha.1",
+      "comments": {
+        "prerelease": [
+          {
+            "comment": "fix: update router to work with new template primitives",
+            "author": "roeisenb@microsoft.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "fix: update router to new directive APIs.",
+            "author": "roeisenb@microsoft.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "chore: remove rollup of router",
+            "author": "roeisenb@microsoft.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "Upgrade TypeScript",
+            "author": "nicholasrice@users.noreply.github.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "Set prerelease version",
+            "author": "nicholasrice@users.noreply.github.com",
+            "commit": "5b313a3262b977acbee3c2efac87d0d14a82f792",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "chore: configure fast-router for internals stripping",
+            "author": "roeisenb@microsoft.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "refactor: new design for execution context",
+            "author": "roeisenb@microsoft.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "Update the fast-router with the updates to fast-element 2.0 APIs",
+            "author": "7559015+janechu@users.noreply.github.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "fix: update to latest fast-element utilities",
+            "author": "roeisenb@microsoft.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "Fixed an updated export from FAST element 2.0",
+            "author": "7559015+janechu@users.noreply.github.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          }
+        ],
+        "none": [
+          {
+            "comment": "update api extractor and typescript to use the latest versions",
+            "author": "chhol@microsoft.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "docs: update a few readme files",
+            "author": "roeisenb@microsoft.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          },
+          {
+            "comment": "Bump @microsoft/fast-element to v2.0.0-beta.1",
+            "author": "roeisenb@microsoft.com",
+            "commit": "4699e77715068f8610aae908ede6356a249574b6",
+            "package": "@microsoft/fast-router"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sun, 29 May 2022 07:08:52 GMT",
+      "tag": "@microsoft/fast-router_v0.4.2",
+      "version": "0.4.2",
+      "comments": {
+        "none": [
+          {
+            "comment": "Bump @microsoft/fast-element to v1.10.2",
+            "author": "steph@huynhicode.dev",
+            "commit": "283b4838d46ed83c70ff4ad91f7f72a4936d59bf",
+            "package": "@microsoft/fast-router"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 24 May 2022 07:10:02 GMT",
+      "tag": "@microsoft/fast-router_v0.4.2",
+      "version": "0.4.2",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Bump @microsoft/fast-element to v1.10.2",
+            "author": "roeisenb@microsoft.com",
+            "commit": "476be7672653b2e63b9ab771949718aa8f43df0d",
+            "package": "@microsoft/fast-router"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sun, 15 May 2022 07:08:25 GMT",
+      "tag": "@microsoft/fast-router_v0.4.1",
+      "version": "0.4.1",
+      "comments": {
+        "none": [
+          {
+            "comment": "fix url path for npm version badge on README.md",
+            "author": "nicholasrice@users.noreply.github.com",
+            "commit": "f43629c7b3065a95ec05bf6186c851496d5320ec",
+            "package": "@microsoft/fast-router"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sun, 08 May 2022 07:08:18 GMT",
+      "tag": "@microsoft/fast-router_v0.4.1",
+      "version": "0.4.1",
+      "comments": {
+        "none": [
+          {
+            "comment": "Bump @microsoft/fast-element to v1.10.1",
+            "author": "chhol@microsoft.com",
+            "commit": "890ff058b8771c84a9e669b4e9202c43f4d3e7fc",
+            "package": "@microsoft/fast-router"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 06 May 2022 20:58:02 GMT",
+      "tag": "@microsoft/fast-router_v0.4.1",
+      "version": "0.4.1",
+      "comments": {
+        "none": [
+          {
+            "comment": "update api extractor to 7.23.1 to ensure we can support TS 4.7 internal API changes",
+            "author": "chhol@microsoft.com",
+            "commit": "fbc6a7fb670453322c93f8f12a223febad86f735",
+            "package": "@microsoft/fast-router"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 04 May 2022 07:14:00 GMT",
+      "tag": "@microsoft/fast-router_v0.4.1",
+      "version": "0.4.1",
+      "comments": {
+        "none": [
+          {
+            "comment": "Bump @microsoft/fast-element to v1.10.1",
+            "author": "steph@huynhicode.dev",
+            "commit": "c49a98f7f1bd8e167b0b7a96a181990f9a675f34",
+            "package": "@microsoft/fast-router"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 03 May 2022 07:15:44 GMT",
       "tag": "@microsoft/fast-router_v0.4.1",
       "version": "0.4.1",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,45 @@
 # Change Log - @microsoft/fast-router
 
-This log was last generated on Tue, 03 May 2022 07:12:26 GMT and should not be manually modified.
+This log was last generated on Wed, 15 Jun 2022 17:41:10 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.0.0-alpha.2
+
+Wed, 15 Jun 2022 17:41:10 GMT
+
+### Changes
+
+- chore: fix package.json type fields (roeisenb@microsoft.com)
+
+## 1.0.0-alpha.1
+
+Wed, 01 Jun 2022 17:53:14 GMT
+
+### Changes
+
+- fix: update router to work with new template primitives (roeisenb@microsoft.com)
+- fix: update router to new directive APIs. (roeisenb@microsoft.com)
+- chore: remove rollup of router (roeisenb@microsoft.com)
+- Upgrade TypeScript (nicholasrice@users.noreply.github.com)
+- Set prerelease version (nicholasrice@users.noreply.github.com)
+- chore: configure fast-router for internals stripping (roeisenb@microsoft.com)
+- refactor: new design for execution context (roeisenb@microsoft.com)
+- Update the fast-router with the updates to fast-element 2.0 APIs (7559015+janechu@users.noreply.github.com)
+- fix: update to latest fast-element utilities (roeisenb@microsoft.com)
+- Fixed an updated export from FAST element 2.0 (7559015+janechu@users.noreply.github.com)
+
+## 0.4.2
+
+Tue, 24 May 2022 07:10:02 GMT
+
+### Patches
+
+- Bump @microsoft/fast-element to v1.10.2 (roeisenb@microsoft.com)
+
 ## 0.4.1
 
-Tue, 03 May 2022 07:12:26 GMT
+Tue, 03 May 2022 07:15:44 GMT
 
 ### Patches
 

package/README.md

@@ -1,9 +1,6 @@
 # FAST Router
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![npm version](https://badge.fury.io/js/%40microsoft%2Ffast-foundation.svg)](https://badge.fury.io/js/%40microsoft%2Ffast-router)
-
-The `fast-router` package contains a history-based navigation and routing solution designed around web components. By using `fast-router`, you can create multi-page and full application experiences.
+The `@microsoft/fast-router` package contains a history-based navigation and routing solution designed around Web Components. By using `fast-router`, you can create multi-page and full application experiences. The router works with any Web Components, but has special support for Web Components built on FAST.
 
 ## Installation
 
@@ -27,36 +24,10 @@ import { FASTRouter } from '@microsoft/fast-router';
 
 Looking for a setup that integrates with a particular front-end framework or bundler? Check out [our integration docs](https://fast.design/docs/integrations/introduction).
 
-### From CDN
-
-A pre-bundled script that contains all APIs needed to use FAST Router and FAST Element is available on CDN. You can use this script by adding [`type="module"`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) to the script element and then importing from the CDN.
-
-```html
-<!DOCTYPE html>
-<html lang="en">
-    <head>
-        <script type="module">
-          import { FASTRouter } from "https://cdn.jsdelivr.net/npm/@microsoft/fast-router/dist/fast-router.min.js";
-
-          // your code here
-        </script>
-    </head>
-    <!-- ... -->
-</html>
-```
-
-The markup above always references the latest release. When deploying to production, you will want to ship with a specific version. Here's an example of the markup for that:
-
-```html
-<script type="module" src="https://cdn.jsdelivr.net/npm/@microsoft/fast-router@0.2.11/dist/fast-router.min.js"></script>
-```
-
-:::note
-For simplicity, examples throughout the documentation will assume the library has been installed from NPM, but you can always replace the import location with the CDN URL.
-:::
-
 ## Configuration at a Glance
 
+The router is currently in `alpha` while we address a few bugs, finish up some final polish, and write the full documentation. Below is a quick sample of how to configure the router, to help get you going while we complete the full documentation.
+
 #### A Sample Route Configuration
 
 ```ts

package/dist/dts/commands.d.ts

@@ -6,13 +6,13 @@ import { RecognizedRoute } from "./recognizer.js";
 import { NavigationContributor } from "./contributors.js";
 import { NavigationCommitPhase, NavigationPhase } from "./phases.js";
 /**
- * @alpha
+ * @beta
  */
 export interface NavigationCommand {
     createContributor(router: Router, route: RecognizedRoute): Promise<NavigationContributor>;
 }
 /**
- * @alpha
+ * @beta
  */
 export interface RenderCommand extends NavigationCommand {
     layout: Layout;
@@ -20,7 +20,7 @@ export interface RenderCommand extends NavigationCommand {
     createView(): Promise<RouteView>;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare class Ignore implements NavigationCommand {
     createContributor(): Promise<{
@@ -28,7 +28,7 @@ export declare class Ignore implements NavigationCommand {
     }>;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare class Redirect implements NavigationCommand {
     private redirect;
@@ -47,7 +47,7 @@ declare class RenderContributor {
     commit(phase: NavigationCommitPhase): Promise<void>;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare class Render implements RenderCommand {
     private owner;

package/dist/dts/configuration.d.ts

@@ -10,7 +10,7 @@ import { NavigationContributor } from "./contributors.js";
 import { NavigationPhaseHook, NavigationPhaseName } from "./phases.js";
 import { RouteRecognizer } from "./recognizer.js";
 /**
- * @alpha
+ * @beta
  */
 export declare abstract class RouterConfiguration<TSettings = any> {
     private isConfigured;

package/dist/dts/contributors.d.ts

@@ -1,23 +1,41 @@
-import { HTMLDirective } from "@microsoft/fast-element";
+import { AddViewBehaviorFactory, Behavior, HTMLDirective, ViewBehaviorTargets } from "@microsoft/fast-element";
 import { NavigationCommitPhaseHook, NavigationPhaseHook, NavigationPhaseName } from "./phases.js";
+import { RouterExecutionContext } from "./view.js";
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigationContributor<TSettings = any> = Partial<Record<Exclude<NavigationPhaseName, "commit">, NavigationPhaseHook<TSettings>>> & {
     commit?: NavigationCommitPhaseHook<TSettings>;
 };
 /**
- * @alpha
+ * @beta
  */
 export declare function isNavigationPhaseContributor<T extends NavigationPhaseName>(object: any, phase: T): object is Record<T, NavigationPhaseHook>;
 /**
- * @alpha
+ * @beta
  */
 export declare type ContributorOptions = {
     lifecycle?: boolean;
     parameters?: boolean;
 };
+declare class NavigationContributorDirective implements HTMLDirective {
+    private options;
+    id: string;
+    nodeId: string;
+    constructor(options: Required<ContributorOptions>);
+    createHTML(add: AddViewBehaviorFactory): string;
+    createBehavior(targets: ViewBehaviorTargets): NavigationContributorBehavior;
+}
+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;
+}
 /**
- * @alpha
+ * @beta
  */
-export declare function navigationContributor(options?: ContributorOptions): HTMLDirective;
+export declare function navigationContributor(options?: ContributorOptions): NavigationContributorDirective;
+export {};

package/dist/dts/events.d.ts

@@ -4,7 +4,7 @@ import { NavigationPhase } from "./phases.js";
 import { RecognizedRoute } from "./recognizer.js";
 import { Router } from "./router.js";
 /**
- * @alpha
+ * @beta
  */
 export interface RoutingEventSink {
     onUnhandledNavigationMessage(router: Router, message: NavigationMessage): void;
@@ -14,7 +14,7 @@ export interface RoutingEventSink {
     onNavigationEnd(router: Router, route: RecognizedRoute, command: NavigationCommand): void;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare class DefaultRoutingEventSink implements RoutingEventSink {
     onUnhandledNavigationMessage(router: Router, message: NavigationMessage): void;

package/dist/dts/fast-router.d.ts

@@ -2,7 +2,7 @@ import { FASTElement } from "@microsoft/fast-element";
 import { RouterElement } from "./router.js";
 declare const FASTRouter_base: new () => FASTElement & RouterElement;
 /**
- * @alpha
+ * @beta
  */
 export declare class FASTRouter extends FASTRouter_base {
 }

package/dist/dts/links.d.ts

@@ -1,12 +1,12 @@
 /**
- * @alpha
+ * @beta
  */
 export interface LinkHandler {
     connect(): void;
     disconnect(): void;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare class DefaultLinkHandler implements LinkHandler {
     private handler;

package/dist/dts/navigation.d.ts

@@ -1,6 +1,6 @@
 import { Router } from "./router.js";
 /**
- * @alpha
+ * @beta
  */
 export interface Route {
     readonly path: string;
@@ -8,27 +8,27 @@ export interface Route {
     readonly caseSensitive?: boolean;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare class NavigationMessage {
     path: string;
     constructor(path: string);
 }
 /**
- * @alpha
+ * @beta
  */
 export interface NavigationHandler {
     enqueue(msg: NavigationMessage): void;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare const NavigationHandler: Readonly<{
     register(handler: NavigationHandler): void;
     unregister(handler: NavigationHandler): void;
 }>;
 /**
- * @alpha
+ * @beta
  */
 export interface NavigationQueue {
     connect(): void;
@@ -36,7 +36,7 @@ export interface NavigationQueue {
     receive(): Promise<NavigationMessage>;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare const Route: Readonly<{
     path: Readonly<{
@@ -54,7 +54,7 @@ export declare const Route: Readonly<{
     }>;
 }>;
 /**
- * @alpha
+ * @beta
  */
 export declare class DefaultNavigationQueue implements NavigationQueue, NavigationHandler {
     private queue;

package/dist/dts/phases.d.ts

@@ -1,23 +1,23 @@
 import { RecognizedRoute } from "./recognizer.js";
 import { Router } from "./router.js";
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigationPhaseName = "navigate" | "leave" | "construct" | "enter" | "commit";
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigationPhaseHook<TSettings = any> = (phase: NavigationPhase<TSettings>) => Promise<any> | any;
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigationCommitPhaseHook<TSettings = any> = (phase: NavigationCommitPhase<TSettings>) => Promise<any> | any;
 /**
- * @alpha
+ * @beta
  */
 export declare type NavigationPhaseFollowupAction = () => Promise<any> | any;
 /**
- * @alpha
+ * @beta
  */
 export interface NavigationPhase<TSettings = any> {
     readonly name: NavigationPhaseName;
@@ -30,7 +30,7 @@ export interface NavigationPhase<TSettings = any> {
     evaluateContributor(contributor: any, route?: RecognizedRoute<TSettings>, router?: Router<TSettings>): Promise<void>;
 }
 /**
- * @alpha
+ * @beta
  */
 export interface NavigationCommitPhase<TSettings = any> extends Omit<NavigationPhase<TSettings>, "cancel" | "canceled" | "onCancel"> {
     setTitle(title: string): any;

package/dist/dts/process.d.ts

@@ -20,13 +20,13 @@ declare class NavigationPhaseImpl<TSettings = any> implements NavigationCommitPh
     evaluateContributor(contributor: any, route?: RecognizedRoute<TSettings>, router?: Router): Promise<void>;
 }
 /**
- * @alpha
+ * @beta
  */
 export interface NavigationProcess {
     run(router: Router, message: NavigationMessage): Promise<void>;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare class DefaultNavigationProcess<TSettings> {
     private phases;

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

@@ -1,5 +1,5 @@
 /**
- * @alpha
+ * @beta
  */
 export declare const QueryString: Readonly<{
     readonly current: string;
@@ -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 | 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.

package/dist/dts/recognizer.d.ts

@@ -1,10 +1,10 @@
 import { Route } from "./navigation.js";
 /**
- * @alpha
+ * @beta
  */
 export declare type RouteParameterConverter = (value: string | undefined) => any | Promise<any>;
 /**
- * @alpha
+ * @beta
  */
 export declare class ConfigurableRoute implements Route {
     readonly path: string;
@@ -13,7 +13,7 @@ export declare class ConfigurableRoute implements Route {
     constructor(path: string, name: string, caseSensitive: boolean);
 }
 /**
- * @alpha
+ * @beta
  */
 export declare class Endpoint<TSettings = any> {
     readonly route: ConfigurableRoute;
@@ -24,7 +24,7 @@ export declare class Endpoint<TSettings = any> {
     get path(): string;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare class RecognizedRoute<TSettings = any> {
     readonly endpoint: Endpoint<TSettings>;
@@ -37,7 +37,7 @@ export declare class RecognizedRoute<TSettings = any> {
     get settings(): TSettings | null;
 }
 /**
- * @alpha
+ * @beta
  */
 export interface RouteRecognizer<TSettings> {
     add(routeOrRoutes: Route | readonly Route[], settings?: TSettings): void;
@@ -46,7 +46,7 @@ export interface RouteRecognizer<TSettings> {
     generateFromPath(path: string, params: object): string | null;
 }
 /**
- * @alpha
+ * @beta
  */
 export declare class DefaultRouteRecognizer<TSettings> implements RouteRecognizer<TSettings> {
     private names;