@thi.ng/router 4.0.7 → 4.0.8

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-11T12:32:44Z
+- **Last updated**: 2024-04-20T14:42:45Z
 - **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.8](https://github.com/thi-ng/umbrella/tree/@thi.ng/router@4.0.8) (2024-04-20)
+
+#### ♻️ Refactoring
+
+- update type usage ([835dfb0](https://github.com/thi-ng/umbrella/commit/835dfb0))
+
 ### [4.0.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/router@4.0.1) (2024-03-13)
 
 #### ♻️ Refactoring

package/README.md

@@ -66,10 +66,10 @@ import * as rou from "@thi.ng/router";
 Browser ESM import:
 
 ```html
-<script type="module" src="https://cdn.skypack.dev/@thi.ng/router"></script>
+<script type="module" src="https://esm.run/@thi.ng/router"></script>
 ```
 
-[Skypack documentation](https://docs.skypack.dev/)
+[JSDelivr documentation](https://www.jsdelivr.com/)
 
 Package sizes (brotli'd, pre-treeshake): ESM: 1.94 KB
 

package/api.d.ts

@@ -1,4 +1,4 @@
-import type { EVENT_ALL, Fn, IObjectOf } from "@thi.ng/api";
+import type { EVENT_ALL, Fn, IObjectOf, Maybe } from "@thi.ng/api";
 /**
  * A validation function for to-be authenticated routes.
  *
@@ -13,7 +13,7 @@ import type { EVENT_ALL, Fn, IObjectOf } from "@thi.ng/api";
  * The optional `ctx` is an arbitrary user provided context value given to
  * {@link Router.route} (e.g. the original request object).
  */
-export type RouteAuthenticator<T = any> = (match: RouteMatch, route: AugmentedRoute, ctx?: T) => RouteMatch | undefined;
+export type RouteAuthenticator<T = any> = (match: RouteMatch, route: AugmentedRoute, ctx?: T) => Maybe<RouteMatch>;
 /**
  * Route validator subspecs are optional and used to coerce and/or validate
  * individual route parameters.

package/html.d.ts

@@ -22,7 +22,7 @@ export declare class HTMLRouter<T = any> extends Router<T> {
      * @param ctx -
      * @param pushState -
      */
-    route(src: string, ctx?: T, pushState?: boolean): import("./api.js").RouteMatch | undefined;
+    route(src: string, ctx?: T, pushState?: boolean): import("@thi.ng/api").Maybe<import("./api.js").RouteMatch>;
     routeTo(route: string, ctx?: T): void;
     protected handlePopChange(): Fn<PopStateEvent, void>;
     protected handleHashChange(): EventListener;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/router",
-  "version": "4.0.7",
+  "version": "4.0.8",
   "description": "Generic trie-based router with support for wildcards, route param validation/coercion, auth",
   "type": "module",
   "module": "./index.js",
@@ -36,10 +36,10 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.10.1",
-    "@thi.ng/checks": "^3.6.1",
-    "@thi.ng/equiv": "^2.1.55",
-    "@thi.ng/errors": "^2.5.4",
+    "@thi.ng/api": "^8.11.0",
+    "@thi.ng/checks": "^3.6.2",
+    "@thi.ng/equiv": "^2.1.56",
+    "@thi.ng/errors": "^2.5.5",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
@@ -98,5 +98,5 @@
     ],
     "year": 2014
   },
-  "gitHead": "18a0c063a7b33d790e5bc2486c106f45f663ac28\n"
+  "gitHead": "8339d05ecc857e529c7325a9839c0063b89e728d\n"
 }

package/router.d.ts

@@ -1,9 +1,9 @@
-import type { Event, INotify, IObjectOf, Listener, SomeRequired } from "@thi.ng/api";
+import type { Event, INotify, IObjectOf, Listener, Maybe, SomeRequired } from "@thi.ng/api";
 import { type AugmentedRoute, type Route, type RouteMatch, type RouteParamValidator, type RouterEventType, type RouterOpts } from "./api.js";
 import { Trie } from "./trie.js";
 export declare class Router<T = any> implements INotify<RouterEventType> {
     opts: RouterOpts<T>;
-    current: RouteMatch | undefined;
+    current: Maybe<RouteMatch>;
     protected index: Record<string, AugmentedRoute>;
     protected routes: Trie<AugmentedRoute>;
     constructor(config: RouterOpts<T>);
@@ -25,7 +25,7 @@ export declare class Router<T = any> implements INotify<RouterEventType> {
      * @param src - route path to match
      * @param ctx - arbitrary user context
      */
-    route(src: string, ctx?: T): RouteMatch | undefined;
+    route(src: string, ctx?: T): Maybe<RouteMatch>;
     /**
      * Returns a formatted version of given {@link RouteMatch}, incl. any
      * params, or alternatively a registered route ID (and optional route
@@ -37,9 +37,9 @@ export declare class Router<T = any> implements INotify<RouterEventType> {
      */
     format(id: string, params?: any, rest?: string[]): string;
     format(match: SomeRequired<RouteMatch, "id">): string;
-    routeForID(id: string): AugmentedRoute | undefined;
+    routeForID(id: string): Maybe<AugmentedRoute>;
     protected augmentRoute(route: Route): AugmentedRoute;
-    protected matchRoutes(src: string, ctx?: T): RouteMatch | undefined;
+    protected matchRoutes(src: string, ctx?: T): Maybe<RouteMatch>;
     protected validateRouteParams(params: any, validators: IObjectOf<Partial<RouteParamValidator>>): boolean;
     protected handleRouteFailure(): boolean;
 }

package/trie.d.ts

@@ -1,3 +1,4 @@
+import type { Maybe } from "@thi.ng/api";
 /**
  * Trie data structure for storing & matching route patterns with wildcards.
  *
@@ -47,8 +48,8 @@
 export declare class Trie<T> {
     n: Record<string, Trie<T>>;
     v?: T;
-    constructor(key?: string[], v?: T | undefined, i?: number);
+    constructor(key?: string[], v?: Maybe<T>, i?: number);
     set(key: string[], v: T, i?: number): void;
-    get(key: string[], i?: number): T | undefined;
+    get(key: string[], i?: number): Maybe<T>;
 }
 //# sourceMappingURL=trie.d.ts.map