@thi.ng/router 3.2.28 → 3.2.30

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-05-11T12:16:33Z
+- **Last updated**: 2023-08-04T10:58:19Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,13 @@ 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.2.30](https://github.com/thi-ng/umbrella/tree/@thi.ng/router@3.2.30) (2023-08-04)
+
+#### ♻️ Refactoring
+
+- update INotify impl ([d36aca6](https://github.com/thi-ng/umbrella/commit/d36aca6))
+- update INotify impls ([cbdc527](https://github.com/thi-ng/umbrella/commit/cbdc527))
+
 ### [3.2.14](https://github.com/thi-ng/umbrella/tree/@thi.ng/router@3.2.14) (2022-11-28)
 
 #### ♻️ Refactoring

package/api.d.ts

@@ -1,4 +1,4 @@
-import type { Fn, IID, IObjectOf } from "@thi.ng/api";
+import type { EVENT_ALL, Fn, IID, IObjectOf } from "@thi.ng/api";
 /**
  * A validation function for to-be authenticated routes. If this function
  * determines that the user is not allowed to access this route, it should
@@ -148,4 +148,5 @@ export interface HTMLRouterConfig extends RouterConfig {
  */
 export declare const EVENT_ROUTE_CHANGED = "route-changed";
 export declare const EVENT_ROUTE_FAILED = "route-failed";
+export type RouterEventType = typeof EVENT_ROUTE_CHANGED | typeof EVENT_ROUTE_FAILED | typeof EVENT_ALL;
 //# sourceMappingURL=api.d.ts.map

package/basic.d.ts

@@ -1,22 +1,23 @@
 import type { Event, INotify, IObjectOf, Listener } from "@thi.ng/api";
-import { type Route, type RouteMatch, type RouteParamValidator, type RouterConfig } from "./api.js";
-export declare class BasicRouter implements INotify {
+import { type Route, type RouteMatch, type RouteParamValidator, type RouterConfig, type RouterEventType } from "./api.js";
+export declare class BasicRouter implements INotify<RouterEventType> {
     config: RouterConfig;
     current: RouteMatch | undefined;
     routeIndex: Record<string, Route>;
     constructor(config: RouterConfig);
     /** {@inheritDoc @thi.ng/api#INotify.addListener} */
-    addListener(id: string, fn: Listener, scope?: any): boolean;
+    addListener(id: RouterEventType, fn: Listener<RouterEventType>, scope?: any): boolean;
     /** {@inheritDoc @thi.ng/api#INotify.removeListener} */
-    removeListener(id: string, fn: Listener, scope?: any): boolean;
+    removeListener(id: RouterEventType, fn: Listener<RouterEventType>, scope?: any): boolean;
     /** {@inheritDoc @thi.ng/api#INotify.notify} */
-    notify(event: Event): boolean;
+    notify(event: Event<RouterEventType>): boolean;
     start(): void;
     /**
-     * Main router function. Attempts to match given input string
-     * against all configured routes. If none matches, falls back
-     * to default route. Before returning, triggers event with
-     * return value as well.
+     * Main router function. Attempts to match given input string against all
+     * configured routes. Before returning, triggers {@link EVENT_ROUTE_CHANGED}
+     * with return value as well. If none of the routes matches, emits
+     * {@link EVENT_ROUTE_FAILED} and then falls back to configured default
+     * route.
      *
      * @param src - route path to match
      */

package/basic.js

@@ -5,8 +5,8 @@ import { equiv } from "@thi.ng/equiv";
 import { assert } from "@thi.ng/errors/assert";
 import { illegalArgs } from "@thi.ng/errors/illegal-arguments";
 import { illegalArity } from "@thi.ng/errors/illegal-arity";
-import { EVENT_ROUTE_CHANGED, } from "./api.js";
-let BasicRouter = class BasicRouter {
+import { EVENT_ROUTE_CHANGED, EVENT_ROUTE_FAILED, } from "./api.js";
+export let BasicRouter = class BasicRouter {
     constructor(config) {
         this.config = {
             authenticator: (route, _, params) => ({
@@ -29,9 +29,11 @@ let BasicRouter = class BasicRouter {
     }
     /** {@inheritDoc @thi.ng/api#INotify.addListener} */
     // @ts-ignore: arguments
+    // prettier-ignore
     addListener(id, fn, scope) { }
     /** {@inheritDoc @thi.ng/api#INotify.removeListener} */
     // @ts-ignore: arguments
+    // prettier-ignore
     removeListener(id, fn, scope) { }
     /** {@inheritDoc @thi.ng/api#INotify.notify} */
     // @ts-ignore: arguments
@@ -44,10 +46,11 @@ let BasicRouter = class BasicRouter {
         }
     }
     /**
-     * Main router function. Attempts to match given input string
-     * against all configured routes. If none matches, falls back
-     * to default route. Before returning, triggers event with
-     * return value as well.
+     * Main router function. Attempts to match given input string against all
+     * configured routes. Before returning, triggers {@link EVENT_ROUTE_CHANGED}
+     * with return value as well. If none of the routes matches, emits
+     * {@link EVENT_ROUTE_FAILED} and then falls back to configured default
+     * route.
      *
      * @param src - route path to match
      */
@@ -59,6 +62,7 @@ let BasicRouter = class BasicRouter {
         src = src.substring(this.config.prefix.length);
         let match = this.matchRoutes(src);
         if (!match) {
+            this.notify({ id: EVENT_ROUTE_FAILED, value: src });
             if (!this.handleRouteFailure()) {
                 return;
             }
@@ -162,6 +166,5 @@ let BasicRouter = class BasicRouter {
 BasicRouter = __decorate([
     INotifyMixin
 ], BasicRouter);
-export { BasicRouter };
 const isParametricRoute = (route) => route.match.some(isRouteParam);
 const isRouteParam = (x) => x[0] === "?";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/router",
-  "version": "3.2.28",
+  "version": "3.2.30",
   "description": "Generic router for browser & non-browser based applications",
   "type": "module",
   "module": "./index.js",
@@ -34,19 +34,19 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.8.1",
-    "@thi.ng/checks": "^3.3.13",
-    "@thi.ng/equiv": "^2.1.23",
-    "@thi.ng/errors": "^2.2.16",
-    "tslib": "^2.5.0"
+    "@thi.ng/api": "^8.9.0",
+    "@thi.ng/checks": "^3.4.0",
+    "@thi.ng/equiv": "^2.1.25",
+    "@thi.ng/errors": "^2.3.0",
+    "tslib": "^2.6.1"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.34.8",
-    "@thi.ng/testament": "^0.3.16",
-    "rimraf": "^5.0.0",
+    "@microsoft/api-extractor": "^7.36.3",
+    "@thi.ng/testament": "^0.3.18",
+    "rimraf": "^5.0.1",
     "tools": "^0.0.1",
-    "typedoc": "^0.24.6",
-    "typescript": "^5.0.4"
+    "typedoc": "^0.24.8",
+    "typescript": "^5.1.6"
   },
   "keywords": [
     "browser",
@@ -91,5 +91,5 @@
     ],
     "year": 2014
   },
-  "gitHead": "20ab11b687a13228f6a8cecdc5f05ba9105122ea\n"
+  "gitHead": "9fa3f7f8169efa30e3c71b43c82f77393581c3b5\n"
 }