@thi.ng/router 4.0.0 → 4.0.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-03-13T14:04:31Z
+- **Last updated**: 2024-03-13T15:51:27Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.
 
+### [4.0.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/router@4.0.1) (2024-03-13)
+
+#### ♻️ Refactoring
+
+- update/simplify AugmentedRoute handling ([37ae88b](https://github.com/thi-ng/umbrella/commit/37ae88b))
+
 # [4.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/router@4.0.0) (2024-03-13)
 
 #### 🛑 Breaking changes

package/README.md

@@ -71,7 +71,7 @@ For Node.js REPL:
 const router = await import("@thi.ng/router");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.93 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.95 KB
 
 ## Dependencies
 

package/api.d.ts

@@ -11,7 +11,7 @@ import type { EVENT_ALL, Fn, IObjectOf } from "@thi.ng/api";
  * {@link RouterOpts.default}).
  *
  * The optional `ctx` is an arbitrary user provided context value given to
- * {@link BasicRouter.route} (e.g. the original request object).
+ * {@link Router.route} (e.g. the original request object).
  */
 export type RouteAuthenticator<T = any> = (match: RouteMatch, route: AugmentedRoute, ctx?: T) => RouteMatch | undefined;
 /**
@@ -38,9 +38,9 @@ export interface RouteParamValidator {
 export interface Route {
     /**
      * Unique ID for this route. This value will be returned as part of a
-     * {@link RouteMatch} resulting from {@link BasicRouter.route} and also used
-     * to look up routes in {@link BasicRouter.routeForID} and
-     * {@link BasicRouter.format}.
+     * {@link RouteMatch} resulting from {@link Router.route} and also used
+     * to look up routes in {@link Router.routeForID} and
+     * {@link Router.format}.
      */
     id: string;
     /**
@@ -81,20 +81,9 @@ export interface Route {
      * processed.
      */
     auth?: boolean;
-    /**
-     * Reserved property.
-     *
-     * @internal used by {@link AugmentedRoute}
-     */
-    rest?: never;
-    /**
-     * Reserved property.
-     *
-     * @internal used by {@link AugmentedRoute}
-     */
-    params?: never;
 }
-export interface AugmentedRoute extends Omit<Route, "match" | "rest" | "params"> {
+export interface AugmentedRoute {
+    spec: Route;
     match: string[];
     params?: Record<number, string>;
     rest: number;
@@ -129,7 +118,7 @@ export interface RouteMatch {
     redirect?: true;
 }
 /**
- * Configuration object for {@link BasicRouter} and {@link HTMLRouter}
+ * Configuration object for {@link Router} and {@link HTMLRouter}
  * instances.
  */
 export interface RouterOpts<T = any> {
@@ -166,8 +155,8 @@ export interface RouterOpts<T = any> {
     separator?: string;
     /**
      * Route prefix. Default: `/`. All routes to be parsed by
-     * {@link BasicRouter.route} are assumed to have this prefix. All routes
-     * returned by {@link BasicRouter.format} will include this prefix.
+     * {@link Router.route} are assumed to have this prefix. All routes
+     * returned by {@link Router.format} will include this prefix.
      *
      * @remarks
      * If given, the prefix MUST end with {@link RouterOpts.separator}.

package/html.js

@@ -18,7 +18,7 @@ class HTMLRouter extends Router {
     }
     if (this.opts.initial) {
       const route = this.routeForID(this.opts.initial);
-      this.route(this.format({ id: route.id }));
+      this.route(this.format({ id: route.spec.id }));
     } else {
       this.route(this.useFragment ? location.hash : location.pathname);
     }
@@ -80,7 +80,7 @@ class HTMLRouter extends Router {
   handleRouteFailure() {
     this.ignoreHashChange = true;
     location.hash = this.format({
-      id: this.routeForID(this.opts.default).id
+      id: this.routeForID(this.opts.default).spec.id
     });
     this.ignoreHashChange = false;
     return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/router",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Generic trie-based router with support for wildcards, route param validation/coercion, auth",
   "type": "module",
   "module": "./index.js",
@@ -98,5 +98,5 @@
     ],
     "year": 2014
   },
-  "gitHead": "7f3fcbd6c0462b0ce45afa141fe163d1f297fd51\n"
+  "gitHead": "23838381932bb72b7538b612c5ae6f0d8f24a517\n"
 }

package/router.js

@@ -62,7 +62,7 @@ let Router = class {
   start() {
     if (this.opts.initial) {
       const route = this.routeForID(this.opts.initial);
-      this.current = { id: route.id, params: {} };
+      this.current = { id: route.spec.id, params: {} };
       this.notify({ id: EVENT_ROUTE_CHANGED, value: this.current });
     }
   }
@@ -71,7 +71,7 @@ let Router = class {
       try {
         const route = this.augmentRoute(r);
         this.routes.set(route.match, route);
-        this.index[route.id] = route;
+        this.index[r.id] = route;
       } catch (e) {
         illegalArgs(
           `error in route "${r.id}": ${e.origMessage}`
@@ -104,7 +104,7 @@ let Router = class {
         return;
       }
       const route = this.routeForID(this.opts.default);
-      match = { id: route.id, redirect: true };
+      match = { id: route.spec.id, redirect: true };
     }
     if (!equiv(match, this.current)) {
       this.current = match;
@@ -157,7 +157,7 @@ let Router = class {
     const existing = this.routes.get(match);
     if (existing) {
       illegalArgs(
-        `duplicate route: ${match} (id: ${route.id}, conflicts with: ${existing.id})`
+        `duplicate route: ${match} (id: ${route.id}, conflicts with: ${existing.spec.id})`
       );
     }
     let hasParams = false;
@@ -169,7 +169,7 @@ let Router = class {
       return acc;
     }, {});
     return {
-      ...route,
+      spec: route,
       match,
       params: hasParams ? params : void 0,
       rest: match.indexOf("+")
@@ -187,16 +187,17 @@ let Router = class {
         {}
       );
     }
-    if (route.validate && !this.validateRouteParams(params, route.validate)) {
+    const validator = route.spec.validate;
+    if (validator && !this.validateRouteParams(params, validator)) {
       return;
     }
     const rest = route.rest >= 0 ? curr.slice(route.rest) : void 0;
     let match = {
-      id: route.id,
+      id: route.spec.id,
       params,
       rest
     };
-    if (route.auth) {
+    if (route.spec.auth) {
       match = this.opts.authenticator(match, route, ctx);
       if (match && !this.index[match.id]) {
         illegalState(