@microsoft/fast-router 1.0.0-alpha.27 → 1.0.0-alpha.29

package/CHANGELOG.json

@@ -1,6 +1,62 @@
 {
   "name": "@microsoft/fast-router",
   "entries": [
+    {
+      "date": "Wed, 11 Dec 2024 19:52:58 GMT",
+      "version": "1.0.0-alpha.29",
+      "tag": "@microsoft/fast-router_v1.0.0-alpha.29",
+      "comments": {
+        "prerelease": [
+          {
+            "author": "7559015+janechu@users.noreply.github.com",
+            "package": "@microsoft/fast-router",
+            "commit": "1238af4df3abec01799cb05c5657f8d245cf3f25",
+            "comment": "Change the router to use peerDependency for fast-element"
+          },
+          {
+            "author": "beachball",
+            "package": "@microsoft/fast-router",
+            "comment": "Bump @microsoft/fast-element to v2.0.1",
+            "commit": "not available"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Mon, 19 Aug 2024 22:04:19 GMT",
+      "version": "1.0.0-alpha.28",
+      "tag": "@microsoft/fast-router_v1.0.0-alpha.28",
+      "comments": {
+        "none": [
+          {
+            "author": "13071055+chrisdholt@users.noreply.github.com",
+            "package": "@microsoft/fast-router",
+            "commit": "630a5e25a953201afa016e54aa77cf68d9d7663a",
+            "comment": "update beachball and move disallowedChangeTypes to package.json"
+          },
+          {
+            "author": "7559015+janechu@users.noreply.github.com",
+            "package": "@microsoft/fast-router",
+            "commit": "78910b1158a6a24b717b3d94616fa93ab6786ab4",
+            "comment": "Remove yarn and lerna in favor of npm"
+          }
+        ],
+        "prerelease": [
+          {
+            "author": "7559015+janechu@users.noreply.github.com",
+            "package": "@microsoft/fast-router",
+            "commit": "035aefc8a25f4f75f3eb2e8cfb4dd0c60e0d2f67",
+            "comment": "Fix CodeQL issues"
+          },
+          {
+            "author": "beachball",
+            "package": "@microsoft/fast-router",
+            "comment": "Bump @microsoft/fast-element to v2.0.0",
+            "commit": "not available"
+          }
+        ]
+      }
+    },
     {
       "date": "Thu, 20 Jun 2024 17:00:56 GMT",
       "version": "1.0.0-alpha.27",

package/CHANGELOG.md

@@ -1,9 +1,27 @@
 # Change Log - @microsoft/fast-router
 
-This log was last generated on Thu, 20 Jun 2024 17:00:56 GMT and should not be manually modified.
+This log was last generated on Wed, 11 Dec 2024 19:52:58 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.0.0-alpha.29
+
+Wed, 11 Dec 2024 19:52:58 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

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

@@ -3,7 +3,7 @@ import { NavigationCommitPhaseHook, NavigationPhaseHook, NavigationPhaseName } f
 /**
  * @beta
  */
-export type NavigationContributor<TSettings = any> = Partial<Record<Exclude<NavigationPhaseName, "commit">, NavigationPhaseHook<TSettings>>> & {
+export declare type NavigationContributor<TSettings = any> = Partial<Record<Exclude<NavigationPhaseName, "commit">, NavigationPhaseHook<TSettings>>> & {
     commit?: NavigationCommitPhaseHook<TSettings>;
 };
 /**
@@ -13,7 +13,7 @@ export declare function isNavigationPhaseContributor<T extends NavigationPhaseNa
 /**
  * @beta
  */
-export type ContributorOptions = {
+export declare type ContributorOptions = {
     lifecycle?: boolean;
     parameters?: boolean;
 };

package/dist/dts/phases.d.ts

@@ -3,19 +3,19 @@ import { Router } from "./router.js";
 /**
  * @beta
  */
-export type NavigationPhaseName = "navigate" | "leave" | "construct" | "enter" | "commit";
+export declare type NavigationPhaseName = "navigate" | "leave" | "construct" | "enter" | "commit";
 /**
  * @beta
  */
-export type NavigationPhaseHook<TSettings = any> = (phase: NavigationPhase<TSettings>) => Promise<any> | any;
+export declare type NavigationPhaseHook<TSettings = any> = (phase: NavigationPhase<TSettings>) => Promise<any> | any;
 /**
  * @beta
  */
-export type NavigationCommitPhaseHook<TSettings = any> = (phase: NavigationCommitPhase<TSettings>) => Promise<any> | any;
+export declare type NavigationCommitPhaseHook<TSettings = any> = (phase: NavigationCommitPhase<TSettings>) => Promise<any> | any;
 /**
  * @beta
  */
-export type NavigationPhaseFollowupAction = () => Promise<any> | any;
+export declare type NavigationPhaseFollowupAction = () => Promise<any> | any;
 /**
  * @beta
  */

package/dist/dts/recognizer.d.ts

@@ -11,7 +11,7 @@ export interface RouteParameterConverterContext<TSettings = any> {
 /**
  * @beta
  */
-export type RouteParameterConverter = (name: string, value: string | undefined, context: RouteParameterConverterContext) => any | Promise<any>;
+export declare type RouteParameterConverter = (name: string, value: string | undefined, context: RouteParameterConverterContext) => any | Promise<any>;
 /**
  * @beta
  */

package/dist/dts/routes.d.ts

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

package/dist/esm/process.js

@@ -1,12 +1,6 @@
 import { __awaiter } from "tslib";
 import { isNavigationPhaseContributor } from "./contributors.js";
 class NavigationPhaseImpl {
-    get route() {
-        return this.routes[this.routes.length - 1];
-    }
-    get router() {
-        return this.routers[this.routers.length - 1];
-    }
     constructor(name, route, router, commitActions, cancelActions) {
         this.name = name;
         this.commitActions = commitActions;
@@ -18,6 +12,12 @@ class NavigationPhaseImpl {
         this.routes.push(route);
         this.routers.push(router);
     }
+    get route() {
+        return this.routes[this.routes.length - 1];
+    }
+    get router() {
+        return this.routers[this.routers.length - 1];
+    }
     cancel(callback) {
         this.canceled = true;
         if (callback) {

package/dist/esm/query-string.js

@@ -1,5 +1,5 @@
 const encode = encodeURIComponent;
-const encodeKey = (key) => encode(key).replace("%24", "$");
+const encodeKey = (key) => encode(key).replace(/%24/g, "$");
 function buildParam(key, value, traditional) {
     let result = [];
     if (value === null || value === undefined) {
@@ -51,14 +51,15 @@ function parseComplexParam(queryParams, keys, value) {
         if (j < keysLastIndex) {
             // The value has to be an array or a false value
             // It can happen that the value is no array if the key was repeated with traditional style like `list=1&list[]=2`
-            const prevValue = !currentParams[key] || typeof currentParams[key] === "object"
-                ? currentParams[key]
-                : [currentParams[key]];
-            currentParams = currentParams[key] =
-                prevValue || (isNaN(keys[j + 1]) ? {} : []);
+            const prevValue = !currentParams.get(key) || typeof currentParams.get(key) === "object"
+                ? currentParams.get(key)
+                : [currentParams.get(key)];
+            currentParams.set(key, prevValue || (isNaN(keys[j + 1]) ? {} : []));
+            currentParams = currentParams.get(key);
         }
         else {
-            currentParams = currentParams[key] = value;
+            currentParams.set(key, value);
+            currentParams = currentParams.get(key);
         }
     }
 }

package/dist/esm/recognizer.js

@@ -249,13 +249,13 @@ function compareChains(a, b) {
     return a.compareTo(b);
 }
 class RecognizeResult {
-    get isEmpty() {
-        return this.candidates.length === 0;
-    }
     constructor(rootState) {
         this.candidates = [];
         this.candidates = [new Candidate([""], [rootState], [], this)];
     }
+    get isEmpty() {
+        return this.candidates.length === 0;
+    }
     getSolution() {
         const candidates = this.candidates.filter(hasEndpoint);
         if (candidates.length === 0) {
@@ -539,13 +539,13 @@ function isNotEmpty(segment) {
     return segment.length > 0;
 }
 class StaticSegment {
-    get kind() {
-        return 3 /* SegmentKind.static */;
-    }
     constructor(value, caseSensitive) {
         this.value = value;
         this.caseSensitive = caseSensitive;
     }
+    get kind() {
+        return 3 /* SegmentKind.static */;
+    }
     appendTo(state) {
         const { value, value: { length }, } = this;
         if (this.caseSensitive) {
@@ -573,13 +573,13 @@ class StaticSegment {
     }
 }
 class DynamicSegment {
-    get kind() {
-        return 2 /* SegmentKind.dynamic */;
-    }
     constructor(name, optional) {
         this.name = name;
         this.optional = optional;
     }
+    get kind() {
+        return 2 /* SegmentKind.dynamic */;
+    }
     appendTo(state) {
         state = state.append(/* segment */ this, /* value   */ "/");
         return state;
@@ -595,12 +595,12 @@ class DynamicSegment {
     }
 }
 class StarSegment {
-    get kind() {
-        return 1 /* SegmentKind.star */;
-    }
     constructor(name) {
         this.name = name;
     }
+    get kind() {
+        return 1 /* SegmentKind.star */;
+    }
     appendTo(state) {
         state = state.append(/* segment */ this, /* value   */ "");
         return state;