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

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';
 
 /**
@@ -41,13 +41,6 @@ export declare type ContributorOptions = {
     parameters?: boolean;
 };
 
-/**
- * @beta
- */
-export declare type ConverterObject = {
-    convert: RouteParameterConverter;
-};
-
 /**
  * @beta
  */
@@ -202,7 +195,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;
@@ -322,7 +315,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;
 }
 
 /**
@@ -342,22 +335,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;
 }
 
 /**
@@ -449,7 +441,7 @@ export declare interface NavigationQueue {
 /**
  * @beta
  */
-export declare type ParameterConverter = RouteParameterConverter | ConverterObject | Constructable<ConverterObject>;
+export declare type ParameterConverter = RouteParameterConverter | RouteParameterConverterObject | Constructable<RouteParameterConverterObject>;
 
 /**
  * @beta
@@ -475,7 +467,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.
@@ -652,7 +644,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
@@ -741,31 +750,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;
 }

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
@@ -42,11 +42,6 @@ export type ContributorOptions = {
     parameters?: boolean;
 };
 
-// @beta (undocumented)
-export type ConverterObject = {
-    convert: RouteParameterConverter;
-};
-
 // @beta (undocumented)
 export class DefaultLinkHandler implements LinkHandler {
     // (undocumented)
@@ -152,7 +147,7 @@ export type FASTElementConstructor = new () => FASTElement;
 
 // @beta (undocumented)
 export class FASTElementLayout implements Layout {
-    constructor(template?: ViewTemplate | null, styles?: ComposableStyles | ComposableStyles[] | null, runBeforeCommit?: boolean);
+    constructor(template?: ViewTemplate | null, styles?: ComposableStyles | ComposableStyles[] | undefined, runBeforeCommit?: boolean);
     // (undocumented)
     afterCommit(routerElement: HTMLElement): Promise<void>;
     // (undocumented)
@@ -246,7 +241,7 @@ export interface NavigationCommand {
 // @beta (undocumented)
 export interface NavigationCommitPhase<TSettings = any> extends Omit<NavigationPhase<TSettings>, "cancel" | "canceled" | "onCancel"> {
     // (undocumented)
-    setTitle(title: string): any;
+    setTitle(title: string): void;
 }
 
 // @beta (undocumented)
@@ -327,7 +322,7 @@ export interface NavigationQueue {
 }
 
 // @beta (undocumented)
-export type ParameterConverter = RouteParameterConverter | ConverterObject | Constructable<ConverterObject>;
+export type ParameterConverter = RouteParameterConverter | RouteParameterConverterObject | Constructable<RouteParameterConverterObject>;
 
 // @beta (undocumented)
 export type ParentRouteDefinition<TSettings = any> = PathedRouteDefinition<TSettings> & LayoutAndTransitionRouteDefinition & {
@@ -340,7 +335,7 @@ export type PathedRouteDefinition<TSettings = any> = SupportsSettings<TSettings>
 // @beta (undocumented)
 export const QueryString: Readonly<{
     readonly current: string;
-    build(params: Object, traditional?: boolean): string;
+    build(params: Record<string, string>, traditional?: boolean): string;
     separate(path: string): Readonly<{
         path: string;
         queryString: string;
@@ -474,7 +469,24 @@ export type RouteMatch<TSettings = any> = {
 };
 
 // @beta (undocumented)
-export type RouteParameterConverter = (value: string | undefined) => any | Promise<any>;
+export type RouteParameterConverter = (name: string, value: string | undefined, context: RouteParameterConverterContext) => any | Promise<any>;
+
+// @beta (undocumented)
+export interface RouteParameterConverterContext<TSettings = any> {
+    // (undocumented)
+    readonly endpoint: Endpoint<TSettings>;
+    // (undocumented)
+    readonly params: Readonly<Record<string, string | undefined>>;
+    // (undocumented)
+    readonly queryParams: Record<string, string>;
+    // (undocumented)
+    readonly typedParams: Record<string, any>;
+}
+
+// @beta (undocumented)
+export type RouteParameterConverterObject = {
+    convert: RouteParameterConverter;
+};
 
 // @beta (undocumented)
 export interface Router<TSettings = any> {
@@ -575,27 +587,24 @@ export interface RouterElement extends HTMLElement {
     // (undocumented)
     config: RouterConfiguration | null;
     // (undocumented)
-    connectedCallback(): any;
+    connectedCallback(): void;
     // (undocumented)
-    disconnectedCallback(): any;
+    disconnectedCallback(): void;
 }
 
 // @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.2",
+  "version": "1.0.0-alpha.21",
   "author": {
     "name": "Microsoft",
     "url": "https://discord.gg/FcSNfg4"
@@ -48,7 +48,7 @@
   "devDependencies": {
     "@microsoft/api-extractor": "7.24.2",
     "@types/chai": "^4.2.11",
-    "@types/karma": "^5.0.0",
+    "@types/karma": "^6.3.3",
     "@types/mocha": "^7.0.2",
     "@types/webpack-env": "^1.15.2",
     "chai": "^4.2.0",
@@ -58,7 +58,7 @@
     "istanbul-instrumenter-loader": "^3.0.1",
     "jsdom": "^16.2.2",
     "jsdom-global": "3.0.2",
-    "karma": "^5.0.4",
+    "karma": "^6.4.1",
     "karma-chrome-launcher": "^3.1.0",
     "karma-coverage": "^2.0.2",
     "karma-coverage-istanbul-reporter": "^3.0.0",
@@ -80,6 +80,6 @@
     "webpack-cli": "^4.9.2"
   },
   "dependencies": {
-    "@microsoft/fast-element": "^2.0.0-beta.2"
+    "@microsoft/fast-element": "^2.0.0-beta.21"
   }
 }