@microsoft/fast-router 1.0.0-alpha.6 → 1.0.0-alpha.7

package/CHANGELOG.json

@@ -1,6 +1,27 @@
 {
   "name": "@microsoft/fast-router",
   "entries": [
+    {
+      "date": "Fri, 23 Sep 2022 22:53:27 GMT",
+      "tag": "@microsoft/fast-router_v1.0.0-alpha.7",
+      "version": "1.0.0-alpha.7",
+      "comments": {
+        "prerelease": [
+          {
+            "author": "roeisenb@microsoft.com",
+            "package": "@microsoft/fast-router",
+            "commit": "2edd63a8abe24c68cfc7c76d773c912c6f2d6543",
+            "comment": "fix: update router to use the new behavior API"
+          },
+          {
+            "author": "beachball",
+            "package": "@microsoft/fast-router",
+            "comment": "Bump @microsoft/fast-element to v2.0.0-beta.7",
+            "commit": "1646b26450a08a77c8bd6302560fe12cc6989ae1"
+          }
+        ]
+      }
+    },
     {
       "date": "Thu, 01 Sep 2022 21:53:34 GMT",
       "tag": "@microsoft/fast-router_v1.0.0-alpha.6",

package/CHANGELOG.md

@@ -1,9 +1,18 @@
 # Change Log - @microsoft/fast-router
 
-This log was last generated on Thu, 01 Sep 2022 21:53:34 GMT and should not be manually modified.
+This log was last generated on Fri, 23 Sep 2022 22:53:27 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 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

package/dist/dts/contributors.d.ts

@@ -1,6 +1,5 @@
-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
  */
@@ -18,20 +17,20 @@ export declare type ContributorOptions = {
     lifecycle?: boolean;
     parameters?: boolean;
 };
-declare class NavigationContributorDirective implements HTMLDirective {
-    private options;
+declare class NavigationContributorDirective implements ViewBehaviorFactory {
+    readonly options: Required<ContributorOptions>;
     id: string;
     nodeId: 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/view.d.ts

@@ -4,19 +4,14 @@ import { Router } from "./router.js";
  * @beta
  */
 export declare type RouterExecutionContext = ExecutionContext & {
-    router: Router;
+    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;
 }

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.nodeId];
+        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/router.js

@@ -3,7 +3,6 @@ import { FASTElement } from "@microsoft/fast-element";
 import { composedParent } from "@microsoft/fast-element/utilities";
 import { NavigationMessage } from "./navigation.js";
 import { childRouteParameter } from "./routes.js";
-import { RouterExecutionContext } from "./view.js";
 const routerProperty = "$router";
 function findParentRouterForElement(element) {
     let parent = element;
@@ -137,7 +136,8 @@ export class DefaultRouter {
         return __awaiter(this, void 0, void 0, function* () {
             this.newRoute = route;
             this.newView = yield command.createView();
-            this.newView.bind(route.allTypedParams, RouterExecutionContext.create(this));
+            this.newView.context.router = this;
+            this.newView.bind(route.allTypedParams);
             this.newView.appendTo(this.host);
             yield command.transition.begin(this.host, this.view, this.newView);
             return {

package/dist/esm/view.js

@@ -1,18 +1,6 @@
 import { __awaiter } from "tslib";
-import { ElementStyles, ExecutionContext, html, } from "@microsoft/fast-element";
+import { ElementStyles, html, } from "@microsoft/fast-element";
 import { isFASTElementHost } from "./router.js";
-/**
- * @beta
- */
-export const RouterExecutionContext = Object.freeze({
-    create(router) {
-        return Object.create(ExecutionContext.default, {
-            router: {
-                value: router,
-            },
-        });
-    },
-});
 /**
  * @beta
  */
@@ -58,8 +46,8 @@ export class FASTElementLayout {
             if (routerElement.$fastController.template !== this.template) {
                 routerElement.$fastController.template = this.template;
             }
-            if (routerElement.$fastController.styles !== this.styles) {
-                routerElement.$fastController.styles = this.styles;
+            if (routerElement.$fastController.mainStyles !== this.styles) {
+                routerElement.$fastController.mainStyles = this.styles;
             }
         }
     }

package/dist/fast-router.api.json

@@ -9097,11 +9097,11 @@
             {
               "kind": "Reference",
               "text": "ExecutionContext",
-              "canonicalReference": "@microsoft/fast-element!ExecutionContext:class"
+              "canonicalReference": "@microsoft/fast-element!ExecutionContext:interface"
             },
             {
               "kind": "Content",
-              "text": " & {\n    router: "
+              "text": " & {\n    router?: "
             },
             {
               "kind": "Reference",
@@ -9124,41 +9124,6 @@
             "endIndex": 5
           }
         },
-        {
-          "kind": "Variable",
-          "canonicalReference": "@microsoft/fast-router!RouterExecutionContext:var",
-          "docComment": "/**\n * @beta\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "RouterExecutionContext: "
-            },
-            {
-              "kind": "Reference",
-              "text": "Readonly",
-              "canonicalReference": "!Readonly:type"
-            },
-            {
-              "kind": "Content",
-              "text": "<{\n    create(router: "
-            },
-            {
-              "kind": "Reference",
-              "text": "Router",
-              "canonicalReference": "@microsoft/fast-router!Router:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "): any;\n}>"
-            }
-          ],
-          "releaseTag": "Beta",
-          "name": "RouterExecutionContext",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 5
-          }
-        },
         {
           "kind": "Interface",
           "canonicalReference": "@microsoft/fast-router!RouteView:interface",
@@ -9245,15 +9210,6 @@
                   "kind": "Content",
                   "text": "<string, any>>"
                 },
-                {
-                  "kind": "Content",
-                  "text": ", context: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "RouterExecutionContext",
-                  "canonicalReference": "@microsoft/fast-router!RouterExecutionContext:type"
-                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -9269,8 +9225,8 @@
               ],
               "isOptional": false,
               "returnTypeTokenRange": {
-                "startIndex": 8,
-                "endIndex": 9
+                "startIndex": 6,
+                "endIndex": 7
               },
               "releaseTag": "Beta",
               "overloadIndex": 1,
@@ -9282,17 +9238,36 @@
                     "endIndex": 5
                   },
                   "isOptional": false
+                }
+              ],
+              "name": "bind"
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/fast-router!RouteView#context:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "context: "
                 },
                 {
-                  "parameterName": "context",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 6,
-                    "endIndex": 7
-                  },
-                  "isOptional": false
+                  "kind": "Reference",
+                  "text": "RouterExecutionContext",
+                  "canonicalReference": "@microsoft/fast-router!RouterExecutionContext:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
                 }
               ],
-              "name": "bind"
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "context",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             },
             {
               "kind": "MethodSignature",

package/dist/fast-router.d.ts

@@ -1,11 +1,11 @@
 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 { ViewBehavior } from '@microsoft/fast-element';
+import { ViewBehaviorFactory } from '@microsoft/fast-element';
+import { ViewController } from '@microsoft/fast-element';
 import { ViewTemplate } from '@microsoft/fast-element';
 
 /* Excluded from this release type: childRouteParameter */
@@ -339,22 +339,22 @@ export declare type NavigationContributor<TSettings = any> = Partial<Record<Excl
  */
 export declare function navigationContributor(options?: ContributorOptions): NavigationContributorDirective;
 
-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;
 }
 
-declare class NavigationContributorDirective implements HTMLDirective {
-    private options;
+declare class NavigationContributorDirective implements ViewBehaviorFactory {
+    readonly options: Required<ContributorOptions>;
     id: string;
     nodeId: string;
     constructor(options: Required<ContributorOptions>);
     createHTML(add: AddViewBehaviorFactory): string;
-    createBehavior(targets: ViewBehaviorTargets): NavigationContributorBehavior;
+    createBehavior(): NavigationContributorBehavior;
 }
 
 /**
@@ -746,23 +746,17 @@ export declare interface RouterElement extends HTMLElement {
  * @beta
  */
 export declare type RouterExecutionContext = ExecutionContext & {
-    router: Router;
+    router?: Router;
 };
 
-/**
- * @beta
- */
-export declare const RouterExecutionContext: Readonly<{
-    create(router: Router): any;
-}>;
-
 declare const routerProperty = "$router";
 
 /**
  * @beta
  */
 export declare 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;
 }

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

@@ -1,11 +1,11 @@
 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 { ViewBehavior } from '@microsoft/fast-element';
+import { ViewBehaviorFactory } from '@microsoft/fast-element';
+import { ViewController } from '@microsoft/fast-element';
 import { ViewTemplate } from '@microsoft/fast-element';
 
 /**
@@ -342,22 +342,22 @@ export declare type NavigationContributor<TSettings = any> = Partial<Record<Excl
  */
 export declare function navigationContributor(options?: ContributorOptions): NavigationContributorDirective;
 
-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;
 }
 
-declare class NavigationContributorDirective implements HTMLDirective {
-    private options;
+declare class NavigationContributorDirective implements ViewBehaviorFactory {
+    readonly options: Required<ContributorOptions>;
     id: string;
     nodeId: string;
     constructor(options: Required<ContributorOptions>);
     createHTML(add: AddViewBehaviorFactory): string;
-    createBehavior(targets: ViewBehaviorTargets): NavigationContributorBehavior;
+    createBehavior(): NavigationContributorBehavior;
 }
 
 /**
@@ -749,23 +749,17 @@ export declare interface RouterElement extends HTMLElement {
  * @beta
  */
 export declare type RouterExecutionContext = ExecutionContext & {
-    router: Router;
+    router?: Router;
 };
 
-/**
- * @beta
- */
-export declare const RouterExecutionContext: Readonly<{
-    create(router: Router): any;
-}>;
-
 declare const routerProperty = "$router";
 
 /**
  * @beta
  */
 export declare 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;
 }

package/docs/api-report.md

@@ -5,13 +5,13 @@
 ```ts
 
 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 { ViewBehavior } from '@microsoft/fast-element';
+import { ViewBehaviorFactory } from '@microsoft/fast-element';
+import { ViewController } from '@microsoft/fast-element';
 import { ViewTemplate } from '@microsoft/fast-element';
 
 // Warning: (ae-internal-missing-underscore) The name "childRouteParameter" should be prefixed with an underscore because the declaration is marked as @internal
@@ -582,20 +582,17 @@ export interface RouterElement extends HTMLElement {
 
 // @beta (undocumented)
 export type RouterExecutionContext = ExecutionContext & {
-    router: Router;
+    router?: Router;
 };
 
-// @beta (undocumented)
-export const RouterExecutionContext: Readonly<{
-    create(router: Router): any;
-}>;
-
 // @beta (undocumented)
 export interface RouteView {
     // (undocumented)
     appendTo(host: HTMLElement): void;
     // (undocumented)
-    bind(allTypedParams: Readonly<Record<string, any>>, context: RouterExecutionContext): void;
+    bind(allTypedParams: Readonly<Record<string, any>>): void;
+    // (undocumented)
+    context: RouterExecutionContext;
     // (undocumented)
     dispose(): void;
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@microsoft/fast-router",
   "description": "A web-components-based router.",
   "sideEffects": false,
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.7",
   "author": {
     "name": "Microsoft",
     "url": "https://discord.gg/FcSNfg4"
@@ -80,6 +80,6 @@
     "webpack-cli": "^4.9.2"
   },
   "dependencies": {
-    "@microsoft/fast-element": "^2.0.0-beta.6"
+    "@microsoft/fast-element": "^2.0.0-beta.7"
   }
 }