@thi.ng/router 3.2.62 → 3.4.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-03-07T20:40:47Z
+- **Last updated**: 2024-03-10T13:28:34Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,22 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [3.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/router@3.4.0) (2024-03-10)
+
+#### 🚀 Features
+
+- add defMatch() helper ([12134b6](https://github.com/thi-ng/umbrella/commit/12134b6))
+
+#### 🩹 Bug fixes
+
+- rebuild index in updateRoutes() ([deb494e](https://github.com/thi-ng/umbrella/commit/deb494e))
+
+## [3.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/router@3.3.0) (2024-03-09)
+
+#### 🚀 Features
+
+- sort & validate routes, add tests ([9243c01](https://github.com/thi-ng/umbrella/commit/9243c01))
+
 ### [3.2.39](https://github.com/thi-ng/umbrella/tree/@thi.ng/router@3.2.39) (2023-11-09)
 
 #### ♻️ Refactoring

package/README.md

@@ -72,7 +72,7 @@ For Node.js REPL:
 const router = await import("@thi.ng/router");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.57 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.66 KB
 
 ## Dependencies
 
@@ -96,7 +96,7 @@ directory is using this package:
 
 [Generated API docs](https://docs.thi.ng/umbrella/router/)
 
-```ts
+```ts tangle:export/readme.ts
 import { HTMLRouter, EVENT_ROUTE_CHANGED } from "@thi.ng/router";
 
 // router configuration
@@ -120,9 +120,8 @@ const config = {
     prefix: "#/",
 
     // actual route defs
-    // these are checked in given order
-    // IMPORTANT: rules with common prefixes MUST be specified in
-    // order of highest precision / longest path
+    // An array of route specs which route input strings will be matched
+    // against. Routes will be sorted from longest to shortest.
     routes: [
         {
             // each route MUST have an ID

package/api.d.ts

@@ -92,8 +92,8 @@ export interface RouteMatch extends IID<string> {
  */
 export interface RouterConfig {
     /**
-     * An array of route specs, which are being attempted to be matched in order
-     * of appearance.
+     * An array of route specs which route input strings will be matched
+     * against. Routes will be sorted from longest to shortest.
      */
     routes: Route[];
     /**

package/basic.d.ts

@@ -9,6 +9,7 @@ export declare class BasicRouter implements INotify<RouterEventType> {
     removeListener(id: RouterEventType, fn: Listener<RouterEventType>, scope?: any): boolean;
     notify(event: Event<RouterEventType>): boolean;
     start(): void;
+    addRoutes(route: Route[]): void;
     /**
      * Main router function. Attempts to match given input string against all
      * configured routes. Before returning, triggers {@link EVENT_ROUTE_CHANGED}
@@ -30,9 +31,27 @@ export declare class BasicRouter implements INotify<RouterEventType> {
     format(id: string, params?: any): string;
     format(match: Partial<RouteMatch>): string;
     routeForID(id: string): Route | undefined;
+    protected updateRoutes(): void;
     protected matchRoutes(src: string): RouteMatch | undefined;
     protected matchRoute(curr: string[], route: Route): RouteMatch | undefined;
     protected validateRouteParams(params: any, validators: IObjectOf<Partial<RouteParamValidator>>): boolean;
     protected handleRouteFailure(): boolean;
 }
+/**
+ * Helper function to define a {@link Route.match} array from a string pattern.
+ *
+ * @example
+ * ```ts tangle:../export/def-match.ts
+ * import { defMatch } from "@thi.ng/router";
+ *
+ * console.log(
+ *   defMatch("/contacts/?id/friends")
+ * );
+ * // ["contacts", "?id", "friends"]
+ * ```
+ *
+ * @param pattern
+ * @param sep
+ */
+export declare const defMatch: (pattern: string, sep?: string) => string[];
 //# sourceMappingURL=basic.d.ts.map

package/basic.js

@@ -35,10 +35,7 @@ let BasicRouter = class {
       removeTrailingSlash: true,
       ...config
     };
-    this.routeIndex = this.config.routes.reduce(
-      (acc, r) => (acc[r.id] = r, acc),
-      {}
-    );
+    this.updateRoutes();
     assert(
       this.routeForID(this.config.defaultRouteID) !== void 0,
       `missing config for default route: '${this.config.defaultRouteID}'`
@@ -73,6 +70,10 @@ let BasicRouter = class {
       this.notify({ id: EVENT_ROUTE_CHANGED, value: this.current });
     }
   }
+  addRoutes(route) {
+    this.config.routes.push(...route);
+    this.updateRoutes();
+  }
   /**
    * Main router function. Attempts to match given input string against all
    * configured routes. Before returning, triggers {@link EVENT_ROUTE_CHANGED}
@@ -135,6 +136,21 @@ let BasicRouter = class {
   routeForID(id) {
     return this.routeIndex[id];
   }
+  updateRoutes() {
+    this.config.routes.sort((a, b) => b.length - a.length);
+    this.config.routes.reduce((acc, x) => {
+      const fmt = x.match.map((y) => isRouteParam(y) ? "*" : y).join("/");
+      if (acc[fmt]) {
+        illegalArgs(`duplicate route: ${x.match} (id: ${x.id})`);
+      }
+      acc[fmt] = true;
+      return acc;
+    }, {});
+    this.routeIndex = this.config.routes.reduce(
+      (acc, r) => (acc[r.id] = r, acc),
+      {}
+    );
+  }
   matchRoutes(src) {
     const routes = this.config.routes;
     const curr = src.split(this.config.separator);
@@ -187,6 +203,8 @@ BasicRouter = __decorateClass([
 ], BasicRouter);
 const isParametricRoute = (route) => route.match.some(isRouteParam);
 const isRouteParam = (x) => x[0] === "?";
+const defMatch = (pattern, sep = "/") => pattern.split(sep).filter((x) => !!x);
 export {
-  BasicRouter
+  BasicRouter,
+  defMatch
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/router",
-  "version": "3.2.62",
+  "version": "3.4.0",
   "description": "Generic router for browser & non-browser based applications",
   "type": "module",
   "module": "./index.js",
@@ -92,5 +92,5 @@
     ],
     "year": 2014
   },
-  "gitHead": "69100942474942f7446ac645d59d91e7dfc352f9\n"
+  "gitHead": "c93ab989dd2013dce1a7f7434f42ef3a270b950f\n"
 }