[patch] update deps

electrovir · Apr 17, 2024 · b11e593 · b11e593
1 parent a079d98
commit b11e593
Show file tree

Hide file tree

Showing 25 changed files with 372 additions and 340 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@electrovir/element-vir-mono-repo",
-    "version": "22.1.1",
+    "version": "22.1.2",
     "private": true,
     "license": "(MIT or CC0 1.0)",
     "author": {
@@ -27,7 +27,7 @@
     },
     "devDependencies": {
         "cspell": "^8.7.0",
-        "dependency-cruiser": "^16.3.0",
+        "dependency-cruiser": "^16.3.1",
         "esbuild": "^0.20.2",
         "html-spec-tags": "^2.2.0",
         "npm-check-updates": "~16.12.3",

diff --git a/packages/element-book-example/package.json b/packages/element-book-example/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@electrovir/element-book-example",
-    "version": "22.1.1",
+    "version": "22.1.2",
     "private": true,
     "license": "(MIT or CC0 1.0)",
     "scripts": {
@@ -10,12 +10,12 @@
         "test:types": "npm run compile"
     },
     "dependencies": {
-        "@augment-vir/browser": "^26.3.2",
+        "@augment-vir/browser": "^26.3.3",
         "element-book": "*",
         "element-vir": "*"
     },
     "devDependencies": {
-        "@augment-vir/node-js": "^26.3.2",
+        "@augment-vir/node-js": "^26.3.3",
         "@open-wc/testing": "^4.0.0",
         "@types/mocha": "^10.0.6",
         "@web/dev-server-esbuild": "^1.0.2",

diff --git a/packages/element-book/package.json b/packages/element-book/package.json
@@ -1,6 +1,6 @@
 {
     "name": "element-book",
-    "version": "22.1.1",
+    "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.2",
-        "@augment-vir/common": "^26.3.2",
+        "@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.1"
+        "spa-router-vir": "^4.0.2",
+        "typed-event-target": "^3.3.0",
+        "vira": "22.1.2"
     },
     "devDependencies": {
-        "@augment-vir/browser-testing": "^26.3.2",
+        "@augment-vir/browser-testing": "^26.3.3",
         "@open-wc/testing": "^4.0.0",
         "@types/chai": "^4.3.14",
         "@types/mocha": "^10.0.6",

diff --git a/...nt-book/src/routing/create-book-router.ts → ...s/element-book/src/routing/book-router.ts b/...nt-book/src/routing/create-book-router.ts → ...s/element-book/src/routing/book-router.ts
@@ -1,16 +1,11 @@
 import {isEnumValue} from '@augment-vir/common';
-import {createSpaRouter, SpaRouter} from 'spa-router-vir';
-import {BookMainRoute, BookRouter, defaultBookFullRoute, ValidBookPaths} from './book-routing';
+import {SpaRouter} from 'spa-router-vir';
+import {BookMainRoute, defaultBookFullRoute, ValidBookPaths} from './book-routing';
 
-export function createBookRouter(baseRoute: string | undefined): BookRouter {
-    type SubTypes =
-        BookRouter extends SpaRouter<infer Paths, infer Search, infer Hash>
-            ? {paths: Paths; search: Search; hash: Hash}
-            : never;
-
-    return createSpaRouter<SubTypes['paths'], SubTypes['search'], SubTypes['hash']>({
-        routeBase: baseRoute,
-        routeSanitizer(rawRoute) {
+export function createBookRouter(basePath: string | undefined) {
+    return new SpaRouter<ValidBookPaths, undefined, undefined>({
+        basePath: basePath,
+        sanitizeRoute(rawRoute) {
             const sanitizedPaths = sanitizePaths(rawRoute.paths);
 
             return {
@@ -22,7 +17,9 @@ export function createBookRouter(baseRoute: string | undefined): BookRouter {
     });
 }
 
-function sanitizePaths(paths: ReadonlyArray<string>): Readonly<ValidBookPaths> {
+export type BookRouter = ReturnType<typeof createBookRouter>;
+
+function sanitizePaths(paths: ReadonlyArray<string>): ValidBookPaths {
     const firstPath = paths[0];
 
     if (!isEnumValue(firstPath, BookMainRoute)) {

diff --git a/packages/element-book/src/routing/book-routing.ts b/packages/element-book/src/routing/book-routing.ts
@@ -1,4 +1,4 @@
-import {FullRoute, SpaRouter} from 'spa-router-vir';
+import {FullRoute} from 'spa-router-vir';
 
 export enum BookMainRoute {
     Search = 'search',
@@ -7,9 +7,7 @@ export enum BookMainRoute {
 
 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 function extractSearchQuery(paths: Readonly<ValidBookPaths>) {
     if (paths[0] === BookMainRoute.Book) {
@@ -24,8 +22,3 @@ export const defaultBookFullRoute: Readonly<BookFullRoute> = {
     paths: [BookMainRoute.Book],
     search: undefined,
 } as const;
-
-export type BookRouter =
-    BookFullRoute extends FullRoute<infer Paths, infer Search, infer Hash>
-        ? Readonly<SpaRouter<Paths, Search, Hash>>
-        : never;
diff --git a/packages/element-book/src/ui/elements/book-breadcrumbs.element.ts b/packages/element-book/src/ui/elements/book-breadcrumbs.element.ts
@@ -1,11 +1,12 @@
 import {css, html} from 'element-vir';
-import {BookFullRoute, BookMainRoute, BookRouter} from '../../routing/book-routing';
+import {BookRouter} from '../../routing/book-router';
+import {BookFullRoute, BookMainRoute} from '../../routing/book-routing';
 import {BookRouteLink} from './common/book-route-link.element';
 import {defineBookElement} from './define-book-element';
 
 export const BookBreadcrumbs = defineBookElement<{
     currentRoute: Readonly<BookFullRoute>;
-    router: BookRouter | undefined;
+    router: Readonly<BookRouter> | undefined;
 }>()({
     tagName: 'book-breadcrumbs',
     styles: css`

diff --git a/packages/element-book/src/ui/elements/book-nav/book-nav.element.ts b/packages/element-book/src/ui/elements/book-nav/book-nav.element.ts
@@ -5,7 +5,8 @@ import {Element16Icon, ViraIcon} from 'vira';
 import {BookEntryTypeEnum} from '../../../data/book-entry/book-entry-type';
 import {isBookTreeNode} from '../../../data/book-tree/book-tree';
 import {BookTreeNode} from '../../../data/book-tree/book-tree-node';
-import {BookMainRoute, BookRouter, defaultBookFullRoute} from '../../../routing/book-routing';
+import {BookRouter} from '../../../routing/book-router';
+import {BookMainRoute, defaultBookFullRoute} from '../../../routing/book-routing';
 import {colorThemeCssVars} from '../../color-theme/color-theme';
 import {BookRouteLink} from '../common/book-route-link.element';
 import {defineBookElement} from '../define-book-element';

diff --git a/packages/element-book/src/ui/elements/common/book-route-link.element.ts b/packages/element-book/src/ui/elements/common/book-route-link.element.ts
@@ -1,12 +1,13 @@
 import {css, html, listen} from 'element-vir';
-import {shouldMouseEventTriggerRoutes} from 'spa-router-vir';
-import {BookFullRoute, BookRouter} from '../../../routing/book-routing';
+import {shouldClickEventTriggerRouteChange} from 'spa-router-vir';
+import {BookRouter} from '../../../routing/book-router';
+import {BookFullRoute} from '../../../routing/book-routing';
 import {ChangeRouteEvent} from '../../events/change-route.event';
 import {defineBookElement} from '../define-book-element';
 
 export const BookRouteLink = defineBookElement<{
     route: Partial<BookFullRoute>;
-    router: BookRouter | undefined;
+    router: Readonly<BookRouter> | undefined;
 }>()({
     tagName: 'book-route-link',
     cssVars: {
@@ -25,16 +26,15 @@ export const BookRouteLink = defineBookElement<{
     `,
     renderCallback: ({inputs, dispatch}) => {
         const linkUrl: string =
-            inputs.router?.createRoutesUrl({
-                ...inputs.router?.getCurrentRawRoutes(),
+            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));

diff --git a/packages/element-book/src/ui/elements/element-book-app/element-book-app.element.ts b/packages/element-book/src/ui/elements/element-book-app/element-book-app.element.ts
@@ -9,13 +9,12 @@ import {
 } 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 {BookRouter, createBookRouter} from '../../../routing/book-router';
 import {
     BookFullRoute,
-    BookRouter,
     defaultBookFullRoute,
     extractSearchQuery,
 } from '../../../routing/book-routing';
-import {createBookRouter} from '../../../routing/create-book-router';
 import {ColorTheme, colorThemeCssVars, setThemeCssVars} from '../../color-theme/color-theme';
 import {ThemeConfig, createTheme} from '../../color-theme/create-color-theme';
 import {ChangeRouteEvent} from '../../events/change-route.event';
@@ -98,7 +97,7 @@ export const ElementBookApp = defineElement<ElementBookConfig>()({
     },
     cleanupCallback({state, updateState}) {
         if (state.router) {
-            state.router.removeAllRouteListeners();
+            state.router.destroy();
             updateState({router: undefined});
         }
     },
@@ -141,7 +140,7 @@ export const ElementBookApp = defineElement<ElementBookConfig>()({
             const newRoute = mergeRoutes(newRouteInput);
 
             if (state.router) {
-                state.router.setRoutes(newRoute);
+                state.router.setRoute(newRoute);
             } else {
                 updateState({
                     currentRoute: {
@@ -171,13 +170,13 @@ export const ElementBookApp = defineElement<ElementBookConfig>()({
                 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: ThemeConfig = {

diff --git a/packages/element-book/src/ui/elements/entry-display/book-breadcrumbs-bar.element.ts b/packages/element-book/src/ui/elements/entry-display/book-breadcrumbs-bar.element.ts
@@ -1,20 +1,16 @@
 import {wait} from '@augment-vir/common';
 import {css, html, listen, renderIf} from 'element-vir';
-import {
-    BookFullRoute,
-    BookMainRoute,
-    BookRouter,
-    defaultBookFullRoute,
-} from '../../../routing/book-routing';
+import {BookRouter} from '../../../routing/book-router';
+import {BookFullRoute, 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';
 import {defineBookElement} from '../define-book-element';
 
 export const BookBreadcrumbsBar = defineBookElement<{
     currentSearch: string;
-    currentRoute: BookFullRoute;
-    router: BookRouter | undefined;
+    currentRoute: Readonly<BookFullRoute>;
+    router: Readonly<BookRouter> | undefined;
 }>()({
     tagName: 'book-breadcrumbs-bar',
     styles: css`

diff --git a/packages/element-book/src/ui/elements/entry-display/book-page/book-page-wrapper.element.ts b/packages/element-book/src/ui/elements/entry-display/book-page/book-page-wrapper.element.ts
@@ -6,7 +6,8 @@ import {
     traverseControls,
 } from '../../../../data/book-entry/book-page/controls-wrapper';
 import {BookTreeNode} from '../../../../data/book-tree/book-tree-node';
-import {BookMainRoute, BookRouter} from '../../../../routing/book-routing';
+import {BookRouter} from '../../../../routing/book-router';
+import {BookMainRoute, ValidBookPaths} from '../../../../routing/book-routing';
 import {BookError} from '../../common/book-error.element';
 import {BookRouteLink} from '../../common/book-route-link.element';
 import {defineBookElement} from '../../define-book-element';
@@ -54,10 +55,10 @@ export const BookPageWrapper = defineBookElement<{
                   <h3 class="header-with-icon">${inputs.pageNode.entry.title}</h3>
               `;
 
-        const linkPaths = [
+        const linkPaths: ValidBookPaths = [
             BookMainRoute.Book,
             ...inputs.pageNode.fullUrlBreadcrumbs,
-        ] as const;
+        ];
 
         const error = combineErrors(inputs.pageNode.entry.errors);
         if (error) {

diff --git a/...ok/src/ui/elements/entry-display/element-example/book-element-example-controls.element.ts b/...ok/src/ui/elements/entry-display/element-example/book-element-example-controls.element.ts
@@ -1,7 +1,8 @@
 import {css, html} from 'element-vir';
 import {BookEntryTypeEnum} from '../../../../data/book-entry/book-entry-type';
 import {BookTreeNode} from '../../../../data/book-tree/book-tree-node';
-import {BookMainRoute, BookRouter} from '../../../../routing/book-routing';
+import {BookRouter} from '../../../../routing/book-router';
+import {BookMainRoute, ValidBookPaths} from '../../../../routing/book-routing';
 import {colorThemeCssVars} from '../../../color-theme/color-theme';
 import {BookRouteLink} from '../../common/book-route-link.element';
 import {defineBookElement} from '../../define-book-element';
@@ -20,10 +21,10 @@ export const BookElementExampleControls = defineBookElement<{
         }
     `,
     renderCallback({inputs}) {
-        const linkPaths = [
+        const linkPaths: ValidBookPaths = [
             BookMainRoute.Book,
             ...inputs.elementExampleNode.fullUrlBreadcrumbs,
-        ] as const;
+        ];
 
         return html`
             <${BookRouteLink.assign({

diff --git a/...book/src/ui/elements/entry-display/element-example/book-element-example-viewer.element.ts b/...book/src/ui/elements/entry-display/element-example/book-element-example-viewer.element.ts
@@ -4,14 +4,12 @@ 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 {unsetInternalState} from '../../../../data/unset';
-import {BookRouter} from '../../../../routing/book-routing';
 import {BookError} from '../../common/book-error.element';
 import {defineBookElement} from '../../define-book-element';
 
 export const BookElementExampleViewer = defineBookElement<{
     elementExampleNode: BookTreeNode<BookEntryTypeEnum.ElementExample>;
     currentPageControls: BookPageControlsValues;
-    router: BookRouter | undefined;
 }>()({
     tagName: 'book-element-example-viewer',
     stateInitStatic: {

diff --git a/...ook/src/ui/elements/entry-display/element-example/book-element-example-wrapper.element.ts b/...ook/src/ui/elements/entry-display/element-example/book-element-example-wrapper.element.ts
@@ -3,7 +3,7 @@ import {css, html} from 'element-vir';
 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';
 import {colorThemeCssVars} from '../../../color-theme/color-theme';
 import {defineBookElement} from '../../define-book-element';
 import {BookElementExampleControls} from './book-element-example-controls.element';

diff --git a/...es/element-book/src/ui/elements/entry-display/entry-display/book-entry-display.element.ts b/...es/element-book/src/ui/elements/entry-display/entry-display/book-entry-display.element.ts
@@ -3,7 +3,8 @@ import {LoaderAnimated24Icon, ViraIcon, viraAnimationDurations} from 'vira';
 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, extractSearchQuery} from '../../../../routing/book-routing';
+import {BookRouter} from '../../../../routing/book-router';
+import {BookFullRoute, extractSearchQuery} from '../../../../routing/book-routing';
 import {defineBookElement} from '../../define-book-element';
 import {ElementBookSlotName} from '../../element-book-app/element-book-app-slots';
 import {BookBreadcrumbsBar} from '../book-breadcrumbs-bar.element';

diff --git a/packages/element-book/src/ui/elements/entry-display/entry-display/create-node-templates.ts b/packages/element-book/src/ui/elements/entry-display/entry-display/create-node-templates.ts
@@ -11,7 +11,7 @@ import {
 } from '../../../../data/book-entry/book-page/controls-wrapper';
 import {isBookTreeNode, traverseToImmediateParent} from '../../../../data/book-tree/book-tree';
 import {BookTreeNode} from '../../../../data/book-tree/book-tree-node';
-import {BookRouter} from '../../../../routing/book-routing';
+import {BookRouter} from '../../../../routing/book-router';
 import {BookError} from '../../common/book-error.element';
 import {BookPageControls} from '../book-page/book-page-controls.element';
 import {BookPageWrapper} from '../book-page/book-page-wrapper.element';

diff --git a/packages/element-vir-example/package.json b/packages/element-vir-example/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@electrovir/element-vir-example",
-    "version": "22.1.1",
+    "version": "22.1.2",
     "private": true,
     "license": "(MIT or CC0 1.0)",
     "author": {
@@ -18,8 +18,8 @@
         "vira": "*"
     },
     "devDependencies": {
-        "@augment-vir/browser-testing": "^26.3.2",
-        "@augment-vir/node-js": "^26.3.2",
+        "@augment-vir/browser-testing": "^26.3.3",
+        "@augment-vir/node-js": "^26.3.3",
         "esbuild": "^0.20.2",
         "markdown-code-example-inserter": "^1.0.0",
         "typedoc": "^0.25.13",