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

package/dist/fast-router.api.json

@@ -461,40 +461,6 @@
             "endIndex": 2
           }
         },
-        {
-          "kind": "TypeAlias",
-          "canonicalReference": "@microsoft/fast-router!ConverterObject:type",
-          "docComment": "/**\n * @beta\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare type ConverterObject = "
-            },
-            {
-              "kind": "Content",
-              "text": "{\n    convert: "
-            },
-            {
-              "kind": "Reference",
-              "text": "RouteParameterConverter",
-              "canonicalReference": "@microsoft/fast-router!RouteParameterConverter:type"
-            },
-            {
-              "kind": "Content",
-              "text": ";\n}"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "releaseTag": "Beta",
-          "name": "ConverterObject",
-          "typeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 4
-          }
-        },
         {
           "kind": "Class",
           "canonicalReference": "@microsoft/fast-router!DefaultLinkHandler:class",
@@ -2410,7 +2376,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "[] | null"
+                  "text": "[] | undefined"
                 },
                 {
                   "kind": "Content",
@@ -3674,7 +3640,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "any"
+                  "text": "void"
                 },
                 {
                   "kind": "Content",
@@ -4817,8 +4783,8 @@
             },
             {
               "kind": "Reference",
-              "text": "ConverterObject",
-              "canonicalReference": "@microsoft/fast-router!ConverterObject:type"
+              "text": "RouteParameterConverterObject",
+              "canonicalReference": "@microsoft/fast-router!RouteParameterConverterObject:type"
             },
             {
               "kind": "Content",
@@ -4835,8 +4801,8 @@
             },
             {
               "kind": "Reference",
-              "text": "ConverterObject",
-              "canonicalReference": "@microsoft/fast-router!ConverterObject:type"
+              "text": "RouteParameterConverterObject",
+              "canonicalReference": "@microsoft/fast-router!RouteParameterConverterObject:type"
             },
             {
               "kind": "Content",
@@ -4999,12 +4965,12 @@
             },
             {
               "kind": "Reference",
-              "text": "Object",
-              "canonicalReference": "!Object:interface"
+              "text": "Record",
+              "canonicalReference": "!Record:type"
             },
             {
               "kind": "Content",
-              "text": ", traditional?: boolean): string;\n    separate(path: string): "
+              "text": "<string, string>, traditional?: boolean): string;\n    separate(path: string): "
             },
             {
               "kind": "Reference",
@@ -7187,7 +7153,16 @@
             },
             {
               "kind": "Content",
-              "text": "(value: string | undefined) => any | "
+              "text": "(name: string, value: string | undefined, context: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RouteParameterConverterContext",
+              "canonicalReference": "@microsoft/fast-router!RouteParameterConverterContext:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => any | "
             },
             {
               "kind": "Reference",
@@ -7205,6 +7180,210 @@
           ],
           "releaseTag": "Beta",
           "name": "RouteParameterConverter",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@microsoft/fast-router!RouteParameterConverterContext:interface",
+          "docComment": "/**\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface RouteParameterConverterContext<TSettings = "
+            },
+            {
+              "kind": "Content",
+              "text": "any"
+            },
+            {
+              "kind": "Content",
+              "text": "> "
+            }
+          ],
+          "releaseTag": "Beta",
+          "typeParameters": [
+            {
+              "typeParameterName": "TSettings",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "name": "RouteParameterConverterContext",
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/fast-router!RouteParameterConverterContext#endpoint:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly endpoint: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Endpoint",
+                  "canonicalReference": "@microsoft/fast-router!Endpoint:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TSettings>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "endpoint",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/fast-router!RouteParameterConverterContext#params:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly params: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Readonly",
+                  "canonicalReference": "!Readonly:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, string | undefined>>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "params",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/fast-router!RouteParameterConverterContext#queryParams:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly queryParams: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, string>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "queryParams",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/fast-router!RouteParameterConverterContext#typedParams:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly typedParams: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "typedParams",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-router!RouteParameterConverterObject:type",
+          "docComment": "/**\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type RouteParameterConverterObject = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    convert: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RouteParameterConverter",
+              "canonicalReference": "@microsoft/fast-router!RouteParameterConverter:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "releaseTag": "Beta",
+          "name": "RouteParameterConverterObject",
           "typeTokenRange": {
             "startIndex": 1,
             "endIndex": 4
@@ -9032,7 +9211,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "any"
+                  "text": "void"
                 },
                 {
                   "kind": "Content",
@@ -9060,7 +9239,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "any"
+                  "text": "void"
                 },
                 {
                   "kind": "Content",
@@ -9097,11 +9276,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 +9303,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 +9389,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 +9404,8 @@
               ],
               "isOptional": false,
               "returnTypeTokenRange": {
-                "startIndex": 8,
-                "endIndex": 9
+                "startIndex": 6,
+                "endIndex": 7
               },
               "releaseTag": "Beta",
               "overloadIndex": 1,
@@ -9282,17 +9417,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 */
@@ -38,13 +38,6 @@ export declare type ContributorOptions = {
     parameters?: boolean;
 };
 
-/**
- * @beta
- */
-export declare type ConverterObject = {
-    convert: RouteParameterConverter;
-};
-
 /**
  * @beta
  */
@@ -199,7 +192,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;
@@ -319,7 +312,7 @@ export declare interface NavigationCommand {
  * @beta
  */
 export declare interface NavigationCommitPhase<TSettings = any> extends Omit<NavigationPhase<TSettings>, "cancel" | "canceled" | "onCancel"> {
-    setTitle(title: string): any;
+    setTitle(title: string): void;
 }
 
 /**
@@ -339,22 +332,21 @@ 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;
-    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;
 }
 
 /**
@@ -446,7 +438,7 @@ export declare interface NavigationQueue {
 /**
  * @beta
  */
-export declare type ParameterConverter = RouteParameterConverter | ConverterObject | Constructable<ConverterObject>;
+export declare type ParameterConverter = RouteParameterConverter | RouteParameterConverterObject | Constructable<RouteParameterConverterObject>;
 
 /**
  * @beta
@@ -472,7 +464,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.
@@ -649,7 +641,24 @@ export declare type RouteMatch<TSettings = any> = {
 /**
  * @beta
  */
-export declare type RouteParameterConverter = (value: string | undefined) => any | Promise<any>;
+export declare type RouteParameterConverter = (name: string, value: string | undefined, context: RouteParameterConverterContext) => any | Promise<any>;
+
+/**
+ * @beta
+ */
+export declare 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 declare type RouteParameterConverterObject = {
+    convert: RouteParameterConverter;
+};
 
 /**
  * @beta
@@ -738,31 +747,25 @@ export declare interface RouteRecognizer<TSettings> {
 export declare interface RouterElement extends HTMLElement {
     readonly [routerProperty]: Router;
     config: RouterConfiguration | null;
-    connectedCallback(): any;
-    disconnectedCallback(): any;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
 }
 
 /**
  * @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;
 }