element-book 22.1.0 → 22.1.2

package/dist/routing/book-router.d.ts

@@ -0,0 +1,4 @@
+import { SpaRouter } from 'spa-router-vir';
+import { ValidBookPaths } from './book-routing';
+export declare function createBookRouter(basePath: string | undefined): SpaRouter<ValidBookPaths, undefined, undefined>;
+export type BookRouter = ReturnType<typeof createBookRouter>;

package/dist/routing/{create-book-router.js → book-router.js}

@@ -1,10 +1,10 @@
 import { isEnumValue } from '@augment-vir/common';
-import { createSpaRouter } from 'spa-router-vir';
+import { SpaRouter } from 'spa-router-vir';
 import { BookMainRoute, defaultBookFullRoute } from './book-routing';
-export function createBookRouter(baseRoute) {
-    return createSpaRouter({
-        routeBase: baseRoute,
-        routeSanitizer(rawRoute) {
+export function createBookRouter(basePath) {
+    return new SpaRouter({
+        basePath: basePath,
+        sanitizeRoute(rawRoute) {
             const sanitizedPaths = sanitizePaths(rawRoute.paths);
             return {
                 paths: sanitizedPaths,

package/dist/routing/book-routing.d.ts

@@ -1,10 +1,9 @@
-import { FullRoute, SpaRouter } from 'spa-router-vir';
+import { FullRoute } from 'spa-router-vir';
 export declare enum BookMainRoute {
     Search = "search",
     Book = "book"
 }
 export type ValidBookPaths = [BookMainRoute.Search, string] | [BookMainRoute.Book, ...string[]];
-export type BookFullRoute = Required<Readonly<FullRoute<ValidBookPaths, undefined | Record<string, string>, undefined>>>;
+export type BookFullRoute = Required<Readonly<FullRoute<ValidBookPaths, undefined, undefined>>>;
 export declare function extractSearchQuery(paths: Readonly<ValidBookPaths>): string;
 export declare const defaultBookFullRoute: Readonly<BookFullRoute>;
-export type BookRouter = BookFullRoute extends FullRoute<infer Paths, infer Search, infer Hash> ? Readonly<SpaRouter<Paths, Search, Hash>> : never;

package/dist/ui/elements/book-breadcrumbs.element.d.ts

@@ -1,5 +1,6 @@
-import { BookFullRoute, BookRouter } from '../../routing/book-routing';
+import { BookRouter } from '../../routing/book-router';
+import { BookFullRoute } from '../../routing/book-routing';
 export declare const BookBreadcrumbs: import("element-vir").DeclarativeElementDefinition<"book-breadcrumbs", {
     currentRoute: Readonly<BookFullRoute>;
-    router: BookRouter | undefined;
+    router: Readonly<BookRouter> | undefined;
 }, {}, {}, `book-breadcrumbs-${string}`, `book-breadcrumbs-${string}`, readonly string[]>;

package/dist/ui/elements/book-nav/book-nav.element.d.ts

@@ -1,5 +1,5 @@
 import { BookTreeNode } from '../../../data/book-tree/book-tree-node';
-import { BookRouter } from '../../../routing/book-routing';
+import { BookRouter } from '../../../routing/book-router';
 export declare const BookNav: import("element-vir").DeclarativeElementDefinition<"book-nav", {
     flattenedNodes: ReadonlyArray<Readonly<BookTreeNode>>;
     selectedPath: ReadonlyArray<string> | undefined;

package/dist/ui/elements/common/book-route-link.element.d.ts

@@ -1,5 +1,6 @@
-import { BookFullRoute, BookRouter } from '../../../routing/book-routing';
+import { BookRouter } from '../../../routing/book-router';
+import { BookFullRoute } from '../../../routing/book-routing';
 export declare const BookRouteLink: import("element-vir").DeclarativeElementDefinition<"book-route-link", {
     route: Partial<BookFullRoute>;
-    router: BookRouter | undefined;
+    router: Readonly<BookRouter> | undefined;
 }, {}, {}, `book-route-link-${string}`, "book-route-link-anchor-padding", readonly string[]>;

package/dist/ui/elements/common/book-route-link.element.js

@@ -1,5 +1,5 @@
 import { css, html, listen } from 'element-vir';
-import { shouldMouseEventTriggerRoutes } from 'spa-router-vir';
+import { shouldClickEventTriggerRouteChange } from 'spa-router-vir';
 import { ChangeRouteEvent } from '../../events/change-route.event';
 import { defineBookElement } from '../define-book-element';
 export const BookRouteLink = defineBookElement()({
@@ -19,15 +19,14 @@ export const BookRouteLink = defineBookElement()({
         }
     `,
     renderCallback: ({ inputs, dispatch }) => {
-        const linkUrl = inputs.router?.createRoutesUrl({
-            ...inputs.router?.getCurrentRawRoutes(),
+        const linkUrl = inputs.router?.createRouteUrl({
             ...inputs.route,
         }) ?? '#';
         return html `
             <a
                 href=${linkUrl}
                 ${listen('click', (clickEvent) => {
-            if (!inputs.router || shouldMouseEventTriggerRoutes(clickEvent)) {
+            if (!inputs.router || shouldClickEventTriggerRouteChange(clickEvent)) {
                 clickEvent.preventDefault();
                 window.scrollTo(0, 0);
                 dispatch(new ChangeRouteEvent(inputs.route));

package/dist/ui/elements/element-book-app/element-book-app.element.d.ts

@@ -8,8 +8,8 @@ type ColorThemeState = {
     theme: ColorTheme;
 };
 export declare const ElementBookApp: import("element-vir").DeclarativeElementDefinition<"element-book-app", ElementBookConfig, {
-    currentRoute: Readonly<Required<Readonly<import("spa-router-vir").FullRoute<import("../../../routing/book-routing").ValidBookPaths, Record<string, string> | undefined, undefined>>>>;
-    router: Readonly<import("spa-router-vir").SpaRouter<import("../../../routing/book-routing").ValidBookPaths, Record<string, string> | undefined, undefined>> | undefined;
+    currentRoute: Readonly<Required<Readonly<import("spa-router-vir").FullRoute<import("../../../routing/book-routing").ValidBookPaths, undefined, undefined>>>>;
+    router: import("spa-router-vir").SpaRouter<import("../../../routing/book-routing").ValidBookPaths, undefined, undefined> | undefined;
     loading: boolean;
     colors: ColorThemeState;
     treeBasedControls: {

package/dist/ui/elements/element-book-app/element-book-app.element.js

@@ -5,8 +5,8 @@ import { isJsonEqual } from 'run-time-assertions';
 import { createNewControls, updateTreeControls, } from '../../../data/book-entry/book-page/controls-wrapper';
 import { createBookTreeFromEntries } from '../../../data/book-tree/book-tree';
 import { searchFlattenedNodes } from '../../../data/book-tree/search-nodes';
+import { createBookRouter } from '../../../routing/book-router';
 import { defaultBookFullRoute, extractSearchQuery, } from '../../../routing/book-routing';
-import { createBookRouter } from '../../../routing/create-book-router';
 import { colorThemeCssVars, setThemeCssVars } from '../../color-theme/color-theme';
 import { createTheme } from '../../color-theme/create-color-theme';
 import { ChangeRouteEvent } from '../../events/change-route.event';
@@ -78,7 +78,7 @@ export const ElementBookApp = defineElement()({
     },
     cleanupCallback({ state, updateState }) {
         if (state.router) {
-            state.router.removeAllRouteListeners();
+            state.router.destroy();
             updateState({ router: undefined });
         }
     },
@@ -115,7 +115,7 @@ export const ElementBookApp = defineElement()({
             }
             const newRoute = mergeRoutes(newRouteInput);
             if (state.router) {
-                state.router.setRoutes(newRoute);
+                state.router.setRoute(newRoute);
             }
             else {
                 updateState({
@@ -138,14 +138,14 @@ export const ElementBookApp = defineElement()({
             if (inputs.internalRouterConfig?.useInternalRouter && !state.router) {
                 const router = createBookRouter(inputs.internalRouterConfig.basePath);
                 updateState({ router });
-                router.addRouteListener(true, (fullRoute) => {
+                router.listen(true, (fullRoute) => {
                     updateState({
                         currentRoute: fullRoute,
                     });
                 });
             }
             else if (!inputs.internalRouterConfig?.useInternalRouter && state.router) {
-                state.router.removeAllRouteListeners();
+                state.router.destroy();
             }
             const inputThemeConfig = {
                 themeColor: inputs.themeColor,

package/dist/ui/elements/entry-display/book-breadcrumbs-bar.element.d.ts

@@ -1,6 +1,7 @@
-import { BookFullRoute, BookRouter } from '../../../routing/book-routing';
+import { BookRouter } from '../../../routing/book-router';
+import { BookFullRoute } from '../../../routing/book-routing';
 export declare const BookBreadcrumbsBar: import("element-vir").DeclarativeElementDefinition<"book-breadcrumbs-bar", {
     currentSearch: string;
-    currentRoute: BookFullRoute;
-    router: BookRouter | undefined;
+    currentRoute: Readonly<BookFullRoute>;
+    router: Readonly<BookRouter> | undefined;
 }, {}, {}, `book-breadcrumbs-bar-${string}`, `book-breadcrumbs-bar-${string}`, readonly string[]>;

package/dist/ui/elements/entry-display/book-breadcrumbs-bar.element.js

@@ -1,6 +1,6 @@
 import { wait } from '@augment-vir/common';
 import { css, html, listen, renderIf } from 'element-vir';
-import { BookMainRoute, defaultBookFullRoute, } from '../../../routing/book-routing';
+import { BookMainRoute, defaultBookFullRoute } from '../../../routing/book-routing';
 import { colorThemeCssVars } from '../../color-theme/color-theme';
 import { ChangeRouteEvent } from '../../events/change-route.event';
 import { BookBreadcrumbs } from '../book-breadcrumbs.element';

package/dist/ui/elements/entry-display/book-page/book-page-wrapper.element.d.ts

@@ -1,7 +1,7 @@
 import { BookEntryTypeEnum } from '../../../../data/book-entry/book-entry-type';
 import { ControlsWrapper } from '../../../../data/book-entry/book-page/controls-wrapper';
 import { BookTreeNode } from '../../../../data/book-tree/book-tree-node';
-import { BookRouter } from '../../../../routing/book-routing';
+import { BookRouter } from '../../../../routing/book-router';
 export declare const BookPageWrapper: import("element-vir").DeclarativeElementDefinition<"book-page-wrapper", {
     isTopLevel: boolean;
     pageNode: BookTreeNode<BookEntryTypeEnum.Page>;

package/dist/ui/elements/entry-display/element-example/book-element-example-controls.element.d.ts

@@ -1,6 +1,6 @@
 import { BookEntryTypeEnum } from '../../../../data/book-entry/book-entry-type';
 import { BookTreeNode } from '../../../../data/book-tree/book-tree-node';
-import { BookRouter } from '../../../../routing/book-routing';
+import { BookRouter } from '../../../../routing/book-router';
 export declare const BookElementExampleControls: import("element-vir").DeclarativeElementDefinition<"book-element-example-controls", {
     elementExampleNode: BookTreeNode<BookEntryTypeEnum.ElementExample>;
     router: BookRouter | undefined;

package/dist/ui/elements/entry-display/element-example/book-element-example-viewer.element.d.ts

@@ -1,9 +1,7 @@
 import { BookEntryTypeEnum } from '../../../../data/book-entry/book-entry-type';
 import { BookPageControlsValues } from '../../../../data/book-entry/book-page/book-page-controls';
 import { BookTreeNode } from '../../../../data/book-tree/book-tree-node';
-import { BookRouter } from '../../../../routing/book-routing';
 export declare const BookElementExampleViewer: import("element-vir").DeclarativeElementDefinition<"book-element-example-viewer", {
     elementExampleNode: BookTreeNode<BookEntryTypeEnum.ElementExample>;
     currentPageControls: BookPageControlsValues;
-    router: BookRouter | undefined;
 }, any, {}, `book-element-example-viewer-${string}`, `book-element-example-viewer-${string}`, readonly string[]>;

package/dist/ui/elements/entry-display/element-example/book-element-example-wrapper.element.d.ts

@@ -1,7 +1,7 @@
 import { BookEntryTypeEnum } from '../../../../data/book-entry/book-entry-type';
 import { BookPageControlsValues } from '../../../../data/book-entry/book-page/book-page-controls';
 import { BookTreeNode } from '../../../../data/book-tree/book-tree-node';
-import { BookRouter } from '../../../../routing/book-routing';
+import { BookRouter } from '../../../../routing/book-router';
 export declare const BookElementExampleWrapper: import("element-vir").DeclarativeElementDefinition<"book-element-example-wrapper", {
     elementExampleNode: BookTreeNode<BookEntryTypeEnum.ElementExample>;
     currentPageControls: BookPageControlsValues;

package/dist/ui/elements/entry-display/entry-display/book-entry-display.element.d.ts

@@ -1,7 +1,8 @@
 import { BookEntryTypeEnum } from '../../../../data/book-entry/book-entry-type';
 import { ControlsWrapper } from '../../../../data/book-entry/book-page/controls-wrapper';
 import { BookTreeNode } from '../../../../data/book-tree/book-tree-node';
-import { BookFullRoute, BookRouter } from '../../../../routing/book-routing';
+import { BookRouter } from '../../../../routing/book-router';
+import { BookFullRoute } from '../../../../routing/book-routing';
 export declare const BookEntryDisplay: import("element-vir").DeclarativeElementDefinition<"book-entry-display", {
     controls: ControlsWrapper;
     currentNodes: ReadonlyArray<BookTreeNode>;

package/dist/ui/elements/entry-display/entry-display/create-node-templates.d.ts

@@ -2,7 +2,7 @@ import { HtmlInterpolation } from 'element-vir';
 import { BookEntryTypeEnum } from '../../../../data/book-entry/book-entry-type';
 import { ControlsWrapper } from '../../../../data/book-entry/book-page/controls-wrapper';
 import { BookTreeNode } from '../../../../data/book-tree/book-tree-node';
-import { BookRouter } from '../../../../routing/book-routing';
+import { BookRouter } from '../../../../routing/book-router';
 export declare function createNodeTemplates({ currentNodes, isTopLevel, router, isSearching, controls, originalTree, }: {
     currentNodes: ReadonlyArray<BookTreeNode>;
     isTopLevel: boolean;

package/dist/ui/events/change-route.event.d.ts

@@ -1 +1 @@
-export declare const ChangeRouteEvent: import("element-vir").DefinedTypedEvent<"element-book-change-route", Partial<Required<Readonly<import("spa-router-vir").FullRoute<import("../../routing/book-routing").ValidBookPaths, Record<string, string> | undefined, undefined>>>>>;
+export declare const ChangeRouteEvent: import("element-vir").DefinedTypedEvent<"element-book-change-route", Partial<Required<Readonly<import("spa-router-vir").FullRoute<import("../../routing/book-routing").ValidBookPaths, undefined, undefined>>>>>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "element-book",
-    "version": "22.1.0",
+    "version": "22.1.2",
     "keywords": [
         "book",
         "design system",
@@ -42,16 +42,16 @@
         "test:watch": "web-test-runner --color --watch --config configs/web-test-runner.config.mjs"
     },
     "dependencies": {
-        "@augment-vir/browser": "^26.3.1",
-        "@augment-vir/common": "^26.3.1",
+        "@augment-vir/browser": "^26.3.3",
+        "@augment-vir/common": "^26.3.3",
         "colorjs.io": "0.5.0",
         "lit-css-vars": "^3.0.9",
-        "spa-router-vir": "^3.0.4",
-        "typed-event-target": "^3.2.1",
-        "vira": "22.1.0"
+        "spa-router-vir": "^4.0.2",
+        "typed-event-target": "^3.3.0",
+        "vira": "22.1.2"
     },
     "devDependencies": {
-        "@augment-vir/browser-testing": "^26.3.1",
+        "@augment-vir/browser-testing": "^26.3.3",
         "@open-wc/testing": "^4.0.0",
         "@types/chai": "^4.3.14",
         "@types/mocha": "^10.0.6",
@@ -66,7 +66,7 @@
         "run-time-assertions": "^1.2.0",
         "type-fest": "^4.15.0",
         "typedoc": "^0.25.13",
-        "typescript": "5.3.3"
+        "typescript": "5.4.5"
     },
     "peerDependencies": {
         "element-vir": ">=17"

package/dist/routing/create-book-router.d.ts

@@ -1,2 +0,0 @@
-import { BookRouter } from './book-routing';
-export declare function createBookRouter(baseRoute: string | undefined): BookRouter;