element-book 22.2.2 → 23.0.0

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

@@ -1,2 +1,2 @@
-import { BookTreeNode } from '../../../data/book-tree/book-tree-node';
+import { BookTreeNode } from '../../../data/book-tree/book-tree-node.js';
 export declare function shouldShowTreeNodeInNav(currentNode: Readonly<BookTreeNode>, selectedPath: undefined | ReadonlyArray<string>): boolean;

package/dist/ui/elements/book-nav/book-nav-filter.js

@@ -1,19 +1,15 @@
-import { isJsonEqual } from 'run-time-assertions';
-import { BookEntryTypeEnum } from '../../../data/book-entry/book-entry-type';
+import { check } from '@augment-vir/assert';
+import { BookEntryType } from '../../../data/book-entry/book-entry-type.js';
 export function shouldShowTreeNodeInNav(currentNode, selectedPath) {
-    if (currentNode.entry.entryType === BookEntryTypeEnum.Root) {
+    if (currentNode.entry.entryType === BookEntryType.Root) {
         return false;
     }
-    if (currentNode.entry.entryType === BookEntryTypeEnum.Page) {
+    if (currentNode.entry.entryType === BookEntryType.Page) {
         return true;
     }
-    const isParentSelected = isJsonEqual(selectedPath, currentNode.fullUrlBreadcrumbs.slice(0, -1));
+    const isParentSelected = check.jsonEquals(selectedPath, currentNode.fullUrlBreadcrumbs.slice(0, -1));
     if (isParentSelected) {
         return true;
     }
-    const isSiblingSelected = isJsonEqual(selectedPath?.slice(0, -1), currentNode.fullUrlBreadcrumbs.slice(0, -1));
-    if (isSiblingSelected) {
-        return true;
-    }
-    return false;
+    return check.jsonEquals(selectedPath?.slice(0, -1), currentNode.fullUrlBreadcrumbs.slice(0, -1));
 }

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

@@ -1,8 +1,8 @@
-import { BookTreeNode } from '../../../data/book-tree/book-tree-node';
-import { BookRouter } from '../../../routing/book-router';
+import { BookTreeNode } from '../../../data/book-tree/book-tree-node.js';
+import { BookRouter } from '../../../routing/book-router.js';
 export declare const BookNav: import("element-vir").DeclarativeElementDefinition<"book-nav", {
     flattenedNodes: ReadonlyArray<Readonly<BookTreeNode>>;
     selectedPath: ReadonlyArray<string> | undefined;
     router: BookRouter | undefined;
-}, {}, {}, `book-nav-${string}`, "book-nav-internal-indent", readonly string[]>;
+}, {}, {}, "book-nav-", "book-nav-internal-indent", readonly []>;
 export declare function scrollSelectedNavElementIntoView(bookNavInstance: typeof BookNav.instanceType): Promise<void>;

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

@@ -1,15 +1,15 @@
-import { checkIfEntirelyInScrollView, waitForAnimationFrame } from '@augment-vir/browser';
+import { check } from '@augment-vir/assert';
+import { checkIfEntirelyInScrollView, waitForAnimationFrame } from '@augment-vir/web';
 import { classMap, css, html, renderIf } from 'element-vir';
-import { isJsonEqual } from 'run-time-assertions';
 import { Element16Icon, ViraIcon } from 'vira';
-import { BookEntryTypeEnum } from '../../../data/book-entry/book-entry-type';
-import { isBookTreeNode } from '../../../data/book-tree/book-tree';
-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';
-import { ElementBookSlotName } from '../element-book-app/element-book-app-slots';
-import { shouldShowTreeNodeInNav } from './book-nav-filter';
+import { BookEntryType } from '../../../data/book-entry/book-entry-type.js';
+import { isBookTreeNode } from '../../../data/book-tree/book-tree.js';
+import { BookMainRoute, defaultBookFullRoute } from '../../../routing/book-routing.js';
+import { colorThemeCssVars } from '../../color-theme/color-theme.js';
+import { BookRouteLink } from '../common/book-route-link.element.js';
+import { defineBookElement } from '../define-book-element.js';
+import { ElementBookSlotName } from '../element-book-app/element-book-app-slots.js';
+import { shouldShowTreeNodeInNav } from './book-nav-filter.js';
 export const BookNav = defineBookElement()({
     tagName: 'book-nav',
     cssVars: {
@@ -70,7 +70,7 @@ export const BookNav = defineBookElement()({
             color: ${colorThemeCssVars['element-book-accent-icon-color'].value};
         }
     `,
-    renderCallback({ inputs }) {
+    render({ inputs }) {
         const navTreeTemplates = inputs.flattenedNodes.map((treeNode) => {
             if (!shouldShowTreeNodeInNav(treeNode, inputs.selectedPath)) {
                 return;
@@ -92,12 +92,12 @@ export const BookNav = defineBookElement()({
                         class=${classMap({
                 'title-row': true,
                 selected: inputs.selectedPath
-                    ? isJsonEqual(inputs.selectedPath, treeNode.fullUrlBreadcrumbs)
+                    ? check.jsonEquals(inputs.selectedPath, treeNode.fullUrlBreadcrumbs)
                     : false,
             })}
                     >
                         <div class="title-text">
-                            ${renderIf(isBookTreeNode(treeNode, BookEntryTypeEnum.ElementExample), html `
+                            ${renderIf(isBookTreeNode(treeNode, BookEntryType.ElementExample), html `
                                     <${ViraIcon.assign({ icon: Element16Icon })}></${ViraIcon}>
                                 `)}
                             ${treeNode.entry.title}

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

@@ -1,3 +1,3 @@
 export declare const BookError: import("element-vir").DeclarativeElementDefinition<"book-error", {
     message: string | ReadonlyArray<string>;
-}, {}, {}, `book-error-${string}`, `book-error-${string}`, readonly string[]>;
+}, {}, {}, "book-error-", "book-error-", readonly []>;

package/dist/ui/elements/common/book-error.element.js

@@ -1,6 +1,6 @@
+import { check } from '@augment-vir/assert';
 import { css, html } from 'element-vir';
-import { isRunTimeType } from 'run-time-assertions';
-import { defineBookElement } from '../define-book-element';
+import { defineBookElement } from '../define-book-element.js';
 export const BookError = defineBookElement()({
     tagName: 'book-error',
     styles: css `
@@ -16,10 +16,8 @@ export const BookError = defineBookElement()({
             padding: 0;
         }
     `,
-    renderCallback({ inputs }) {
-        const paragraphs = isRunTimeType(inputs.message, 'array')
-            ? inputs.message
-            : [inputs.message];
+    render({ inputs }) {
+        const paragraphs = check.isArray(inputs.message) ? inputs.message : [inputs.message];
         return paragraphs.map((paragraph) => html `
                 <p>${paragraph}</p>
             `);

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

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

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

@@ -1,7 +1,7 @@
 import { css, html, listen } from 'element-vir';
 import { shouldClickEventTriggerRouteChange } from 'spa-router-vir';
-import { ChangeRouteEvent } from '../../events/change-route.event';
-import { defineBookElement } from '../define-book-element';
+import { ChangeRouteEvent } from '../../events/change-route.event.js';
+import { defineBookElement } from '../define-book-element.js';
 export const BookRouteLink = defineBookElement()({
     tagName: 'book-route-link',
     cssVars: {
@@ -18,7 +18,7 @@ export const BookRouteLink = defineBookElement()({
             width: 100%;
         }
     `,
-    renderCallback: ({ inputs, dispatch }) => {
+    render: ({ inputs, dispatch }) => {
         const linkUrl = inputs.router?.createRouteUrl({
             ...inputs.route,
         }) ?? '#';

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

@@ -1,2 +1,2 @@
 export type BookTagName = `book-${string}`;
-export declare const defineBookElement: <Inputs extends {}>() => <const TagName extends `book-${string}`, StateInit extends {}, EventsInit extends {}, const HostClassKeys extends `${TagName}-${string}`, const CssVarKeys extends `${TagName}-${string}`, const SlotNames extends readonly string[]>(inputs: import("element-vir").VerifiedElementInit<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>) => import("element-vir").DeclarativeElementDefinition<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>, defineBookElementNoInputs: <const TagName_1 extends `book-${string}`, Inputs_1 extends {}, StateInit_1 extends {}, EventsInit_1 extends {}, const HostClassKeys_1 extends `${TagName_1}-${string}`, const CssVarKeys_1 extends `${TagName_1}-${string}`, const SlotNames_1 extends readonly string[]>(inputs: import("element-vir").VerifiedElementNoInputsInit<TagName_1, Inputs_1, StateInit_1, EventsInit_1, HostClassKeys_1, CssVarKeys_1, SlotNames_1>) => import("element-vir").DeclarativeElementDefinition<TagName_1, Inputs_1, StateInit_1, EventsInit_1, HostClassKeys_1, CssVarKeys_1, SlotNames_1>;
+export declare const defineBookElement: <Inputs extends {}>() => <const TagName extends `book-${string}`, StateInit extends {}, EventsInit extends {}, const HostClassKeys extends `${TagName}-${string}` = `${TagName}-`, const CssVarKeys extends `${TagName}-${string}` = `${TagName}-`, const SlotNames extends ReadonlyArray<string> = readonly []>(inputs: import("element-vir").VerifiedElementInit<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>) => import("element-vir").DeclarativeElementDefinition<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>, defineBookElementNoInputs: <const TagName extends `book-${string}`, Inputs extends {}, StateInit extends {}, EventsInit extends {}, const HostClassKeys extends `${TagName}-${string}` = `${TagName}-`, const CssVarKeys extends `${TagName}-${string}` = `${TagName}-`, const SlotNames extends ReadonlyArray<string> = readonly []>(inputs: import("element-vir").VerifiedElementNoInputsInit<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>) => import("element-vir").DeclarativeElementDefinition<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>;

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

@@ -1,4 +1,17 @@
+/**
+ * Slots to be used on an element-book app instance for inserting custom HTML into the app.
+ *
+ * @category Main
+ */
 export declare enum ElementBookSlotName {
+    /**
+     * Used to specify a footer for the main element example viewer. It always appears at the bottom
+     * of the viewer's scroll area.
+     */
     Footer = "book-footer",
+    /**
+     * Used to specify a header above the navigation sidebar. This is a particularly good place for
+     * branding.
+     */
     NavHeader = "book-nav-header"
 }

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

@@ -1,5 +1,18 @@
+/**
+ * Slots to be used on an element-book app instance for inserting custom HTML into the app.
+ *
+ * @category Main
+ */
 export var ElementBookSlotName;
 (function (ElementBookSlotName) {
+    /**
+     * Used to specify a footer for the main element example viewer. It always appears at the bottom
+     * of the viewer's scroll area.
+     */
     ElementBookSlotName["Footer"] = "book-footer";
+    /**
+     * Used to specify a header above the navigation sidebar. This is a particularly good place for
+     * branding.
+     */
     ElementBookSlotName["NavHeader"] = "book-nav-header";
 })(ElementBookSlotName || (ElementBookSlotName = {}));

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

@@ -1,24 +1,35 @@
-import { ControlsWrapper } from '../../../data/book-entry/book-page/controls-wrapper';
-import { ColorTheme } from '../../color-theme/color-theme';
-import { ThemeConfig } from '../../color-theme/create-color-theme';
-import { ElementBookConfig } from './element-book-config';
-import { GlobalValues } from './global-values';
-type ColorThemeState = {
+import { ControlsWrapper } from '../../../data/book-entry/book-page/controls-wrapper.js';
+import { BookRouter } from '../../../routing/book-router.js';
+import { ColorTheme } from '../../color-theme/color-theme.js';
+import { ThemeConfig } from '../../color-theme/create-color-theme.js';
+import { ElementBookConfig } from './element-book-config.js';
+import { GlobalValues } from './global-values.js';
+/**
+ * Current color theme state used inside of {@link ElementBookApp}.
+ *
+ * @category Internal
+ */
+export type ColorThemeState = {
     config: ThemeConfig | undefined;
     theme: ColorTheme;
 };
+/**
+ * The element-book app itself. Instantiate one of these where you want your element-book pages to
+ * render. Make sure to also provide an array of pages to actually render!
+ *
+ * @category Main
+ */
 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, undefined, undefined>>>>;
-    router: import("spa-router-vir").SpaRouter<import("../../../routing/book-routing").ValidBookPaths, undefined, undefined> | undefined;
+    currentRoute: Readonly<Required<Readonly<import("spa-router-vir").FullRoute<import("../../../routing/book-routing.js").ValidBookPaths, undefined, undefined>>>>;
+    router: undefined | BookRouter;
     loading: boolean;
     colors: ColorThemeState;
     treeBasedControls: {
-        entries: ElementBookConfig['entries'];
+        pages: ElementBookConfig["pages"];
         lastGlobalInputs: GlobalValues;
         controls: ControlsWrapper;
     } | undefined;
     originalWindowTitle: string | undefined;
 }, {
-    pathUpdate: import("element-vir").DefinedTypedEventNameDefinition<readonly string[]>;
+    pathUpdate: import("element-vir").DefineEvent<readonly string[]>;
 }, "element-book-app-", "element-book-app-", readonly []>;
-export {};

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

@@ -1,21 +1,27 @@
-import { waitForAnimationFrame } from '@augment-vir/browser';
-import { extractErrorMessage, isTruthy } from '@augment-vir/common';
+import { check } from '@augment-vir/assert';
+import { extractErrorMessage, makeWritable } from '@augment-vir/common';
+import { waitForAnimationFrame } from '@augment-vir/web';
 import { css, defineElement, defineElementEvent, html, listen } from 'element-vir';
-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 { colorThemeCssVars, setThemeCssVars } from '../../color-theme/color-theme';
-import { createTheme } from '../../color-theme/create-color-theme';
-import { ChangeRouteEvent } from '../../events/change-route.event';
-import { BookNav, scrollSelectedNavElementIntoView } from '../book-nav/book-nav.element';
-import { BookError } from '../common/book-error.element';
-import { BookPageControls } from '../entry-display/book-page/book-page-controls.element';
-import { BookEntryDisplay } from '../entry-display/entry-display/book-entry-display.element';
-import { ElementBookSlotName } from './element-book-app-slots';
-import { getCurrentNodes } from './get-current-nodes';
+import { createNewControls, updateTreeControls, } from '../../../data/book-entry/book-page/controls-wrapper.js';
+import { createBookTreeFromEntries } from '../../../data/book-tree/book-tree.js';
+import { searchFlattenedNodes } from '../../../data/book-tree/search-nodes.js';
+import { createBookRouter } from '../../../routing/book-router.js';
+import { defaultBookFullRoute, extractSearchQuery, } from '../../../routing/book-routing.js';
+import { colorThemeCssVars, setThemeCssVars } from '../../color-theme/color-theme.js';
+import { createTheme } from '../../color-theme/create-color-theme.js';
+import { ChangeRouteEvent } from '../../events/change-route.event.js';
+import { BookNav, scrollSelectedNavElementIntoView } from '../book-nav/book-nav.element.js';
+import { BookError } from '../common/book-error.element.js';
+import { BookPageControls } from '../entry-display/book-page/book-page-controls.element.js';
+import { BookEntryDisplay } from '../entry-display/entry-display/book-entry-display.element.js';
+import { ElementBookSlotName } from './element-book-app-slots.js';
+import { getCurrentNodes } from './get-current-nodes.js';
+/**
+ * The element-book app itself. Instantiate one of these where you want your element-book pages to
+ * render. Make sure to also provide an array of pages to actually render!
+ *
+ * @category Main
+ */
 export const ElementBookApp = defineElement()({
     tagName: 'element-book-app',
     events: {
@@ -71,18 +77,18 @@ export const ElementBookApp = defineElement()({
             max-width: min(400px, 40%);
         }
     `,
-    initCallback({ host, state }) {
-        setTimeout(() => {
-            scrollNav(host, extractSearchQuery(state.currentRoute.paths), state.currentRoute);
+    init({ host, state }) {
+        setTimeout(async () => {
+            await scrollNav(host, extractSearchQuery(state.currentRoute.paths), state.currentRoute);
         }, 500);
     },
-    cleanupCallback({ state, updateState }) {
+    cleanup({ state, updateState }) {
         if (state.router) {
             state.router.destroy();
             updateState({ router: undefined });
         }
     },
-    renderCallback: ({ state, inputs, host, updateState, dispatch, events }) => {
+    render: ({ state, inputs, host, updateState, dispatch, events }) => {
         if (inputs._debug) {
             console.info('rendering element-book app');
         }
@@ -94,7 +100,7 @@ export const ElementBookApp = defineElement()({
         }
         function areRoutesNew(newRouteInput) {
             const newRoute = mergeRoutes(newRouteInput);
-            return !isJsonEqual(state.currentRoute, newRoute);
+            return !check.jsonEquals(state.currentRoute, newRoute);
         }
         function updateWindowTitle(topNodeTitle) {
             if (!inputs.preventWindowTitleChange) {
@@ -105,7 +111,7 @@ export const ElementBookApp = defineElement()({
                     state.originalWindowTitle,
                     topNodeTitle,
                 ]
-                    .filter(isTruthy)
+                    .filter(check.isTruthy)
                     .join(' - ');
             }
         }
@@ -126,14 +132,14 @@ export const ElementBookApp = defineElement()({
                 });
             }
             if (inputs.elementBookRoutePaths &&
-                !isJsonEqual(inputs.elementBookRoutePaths, state.currentRoute.paths)) {
-                dispatch(new events.pathUpdate(newRoute.paths ?? []));
+                !check.jsonEquals(inputs.elementBookRoutePaths, state.currentRoute.paths)) {
+                dispatch(new events.pathUpdate(newRoute.paths));
             }
         }
         try {
             if (inputs.elementBookRoutePaths &&
-                !isJsonEqual(inputs.elementBookRoutePaths, state.currentRoute.paths)) {
-                updateRoutes({ paths: inputs.elementBookRoutePaths });
+                !check.jsonEquals(inputs.elementBookRoutePaths, state.currentRoute.paths)) {
+                updateRoutes({ paths: makeWritable(inputs.elementBookRoutePaths) });
             }
             if (inputs.internalRouterConfig?.useInternalRouter && !state.router) {
                 const router = createBookRouter(inputs.internalRouterConfig.basePath);
@@ -150,7 +156,7 @@ export const ElementBookApp = defineElement()({
             const inputThemeConfig = {
                 themeColor: inputs.themeColor,
             };
-            if (!isJsonEqual(inputThemeConfig, state.colors?.config)) {
+            if (!check.jsonEquals(inputThemeConfig, state.colors.config)) {
                 const newTheme = createTheme(inputThemeConfig);
                 updateState({
                     colors: {
@@ -162,21 +168,21 @@ export const ElementBookApp = defineElement()({
             }
             const debug = inputs._debug ?? false;
             const originalTree = createBookTreeFromEntries({
-                entries: inputs.entries,
+                entries: inputs.pages,
                 debug,
             });
             if (!state.treeBasedControls ||
-                state.treeBasedControls.entries !== inputs.entries ||
+                state.treeBasedControls.pages !== inputs.pages ||
                 state.treeBasedControls.lastGlobalInputs !== inputs.globalValues) {
                 if (inputs._debug) {
                     console.info('regenerating global controls');
                 }
                 updateState({
                     treeBasedControls: {
-                        entries: inputs.entries,
+                        pages: inputs.pages,
                         lastGlobalInputs: inputs.globalValues ?? {},
                         controls: updateTreeControls(originalTree.tree, {
-                            children: state.treeBasedControls?.controls?.children,
+                            children: state.treeBasedControls?.controls.children,
                             controls: inputs.globalValues,
                         }),
                     },
@@ -215,9 +221,9 @@ export const ElementBookApp = defineElement()({
                 updateRoutes(newRoute);
                 const navElement = host.shadowRoot.querySelector(BookNav.tagName);
                 if (!(navElement instanceof BookNav)) {
-                    throw new Error(`Failed to find child '${BookNav.tagName}'`);
+                    throw new TypeError(`Failed to find child '${BookNav.tagName}'`);
                 }
-                scrollNav(host, searchQuery, state.currentRoute);
+                await scrollNav(host, searchQuery, state.currentRoute);
             })}
                     ${listen(BookPageControls.events.controlValueChange, (event) => {
                 if (!state.treeBasedControls) {
@@ -290,7 +296,7 @@ async function scrollNav(host, searchQuery, currentRoutes) {
     }
     const navElement = host.shadowRoot.querySelector(BookNav.tagName);
     if (!(navElement instanceof BookNav)) {
-        throw new Error(`Failed to find child '${BookNav.tagName}'`);
+        throw new TypeError(`Failed to find child '${BookNav.tagName}'`);
     }
     await scrollSelectedNavElementIntoView(navElement);
 }

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

@@ -1,38 +1,48 @@
-import { PartialAndUndefined } from '@augment-vir/common';
+import { PartialWithUndefined } from '@augment-vir/common';
 import { RequireExactlyOne } from 'type-fest';
-import { BookEntry } from '../../../data/book-entry/book-entry';
-import { GlobalValues } from './global-values';
+import type { BookPage } from '../../../data/book-entry/book-page/book-page.js';
+import { ValidBookPaths } from '../../../routing/book-routing.js';
+import { GlobalValues } from './global-values.js';
+/**
+ * Full configuration for an element-book app.
+ *
+ * @category Type
+ */
 export type ElementBookConfig = {
-    /** All element-book entries in order. */
-    entries: ReadonlyArray<BookEntry>;
-} & PartialAndUndefined<OptionalConfig>;
-type OptionalConfig = {
+    /** All element-book pages in order. */
+    pages: ReadonlyArray<BookPage>;
+} & PartialWithUndefined<OptionalConfig>;
+/**
+ * Options for {@link ElementBookConfig} that are optional.
+ *
+ * @category Internal
+ */
+export type OptionalConfig = {
     /** The base theme color from which all other element-book colors will be generated from. */
     themeColor: string;
     _debug: boolean;
     globalValues: GlobalValues;
     preventWindowTitleChange: boolean;
-} & RequireExactlyOne<{
+} & RequireExactlyOne<Readonly<{
     /**
      * Set this internal router config if element-book is intended to be the current website's
      * entire web app. Meaning, you're not embedded element-book within another website.
      *
-     * In this case, element-book will create its own internal router for managing the URL. In other
-     * cases, when element-book is embedded in another website, use the elementBookRoutePaths input
-     * property instead.
+     * In this case, element-book will create its own internal router for managing the URL. In
+     * other cases, when element-book is embedded in another website, use the
+     * elementBookRoutePaths input property instead.
      */
-    internalRouterConfig: {
+    internalRouterConfig: Readonly<{
         useInternalRouter: true;
         /**
          * Path to this page, used for routing. For example, if this page is hosted at
          * www.example.org/my-page then this value should be `my-page`.
          */
         basePath?: string | undefined;
-    };
+    }>;
     /**
      * Current route paths for element-book to handle. These are intended to come from a router
      * that's external to the element-book app itself.
      */
-    elementBookRoutePaths: ReadonlyArray<string>;
-}>;
-export {};
+    elementBookRoutePaths: Readonly<ValidBookPaths>;
+}>>;

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

@@ -1,3 +1,3 @@
-import { BookTreeNode } from '../../../data/book-tree/book-tree-node';
-import { BookFullRoute, ValidBookPaths } from '../../../routing/book-routing';
+import { BookTreeNode } from '../../../data/book-tree/book-tree-node.js';
+import { BookFullRoute, ValidBookPaths } from '../../../routing/book-routing.js';
 export declare function getCurrentNodes(flattenedNodes: ReadonlyArray<Readonly<BookTreeNode>>, currentPaths: Readonly<ValidBookPaths>, updateRoutes: (newRoute: Partial<BookFullRoute>) => void): BookTreeNode[];

package/dist/ui/elements/element-book-app/get-current-nodes.js

@@ -1,5 +1,5 @@
-import { doBreadcrumbsStartWith } from '../../../data/book-entry/url-breadcrumbs';
-import { defaultBookFullRoute } from '../../../routing/book-routing';
+import { doBreadcrumbsStartWith } from '../../../data/book-entry/url-breadcrumbs.js';
+import { defaultBookFullRoute, } from '../../../routing/book-routing.js';
 export function getCurrentNodes(flattenedNodes, currentPaths, updateRoutes) {
     const filteredNodes = filterNodes(flattenedNodes, currentPaths);
     if (filteredNodes.length) {
@@ -8,12 +8,7 @@ export function getCurrentNodes(flattenedNodes, currentPaths, updateRoutes) {
     else {
         updateRoutes(defaultBookFullRoute);
     }
-    const filteredNodesFromDefaultPath = filterNodes(flattenedNodes, defaultBookFullRoute.paths);
-    if (!filteredNodesFromDefaultPath) {
-        throw new Error(`Tried to self-correct for invalid path ${currentPaths.join('/')}
-                        but failed to do so.`);
-    }
-    return filteredNodesFromDefaultPath;
+    return filterNodes(flattenedNodes, defaultBookFullRoute.paths);
 }
 function filterNodes(flattenedNodes, paths) {
     return flattenedNodes.filter((node) => doBreadcrumbsStartWith({

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

@@ -1 +1,6 @@
+/**
+ * Base type for element-book global values.
+ *
+ * @category Internal
+ */
 export type GlobalValues = Readonly<Record<string, unknown>> | undefined;

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

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

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

@@ -1,10 +1,10 @@
 import { wait } from '@augment-vir/common';
 import { css, html, listen, renderIf } from 'element-vir';
-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';
-import { defineBookElement } from '../define-book-element';
+import { BookMainRoute, defaultBookFullRoute } from '../../../routing/book-routing.js';
+import { colorThemeCssVars } from '../../color-theme/color-theme.js';
+import { ChangeRouteEvent } from '../../events/change-route.event.js';
+import { BookBreadcrumbs } from '../book-breadcrumbs.element.js';
+import { defineBookElement } from '../define-book-element.js';
 export const BookBreadcrumbsBar = defineBookElement()({
     tagName: 'book-breadcrumbs-bar',
     styles: css `
@@ -19,7 +19,7 @@ export const BookBreadcrumbsBar = defineBookElement()({
             justify-content: space-between;
         }
     `,
-    renderCallback({ inputs, dispatch }) {
+    render({ inputs, dispatch }) {
         return html `
             ${renderIf(!!inputs.currentSearch, html `
                      
@@ -35,11 +35,11 @@ export const BookBreadcrumbsBar = defineBookElement()({
                 ${listen('input', async (event) => {
             const inputElement = event.currentTarget;
             if (!(inputElement instanceof HTMLInputElement)) {
-                throw new Error('Failed to find input element for search.');
+                throw new TypeError('Failed to find input element for search.');
             }
             const preThrottleValue = inputElement.value;
             // throttle it a bit
-            await wait(200);
+            await wait({ milliseconds: 200 });
             if (inputElement.value !== preThrottleValue) {
                 return;
             }

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

@@ -1,3 +1,3 @@
 export declare const BookEntryDescription: import("element-vir").DeclarativeElementDefinition<"book-entry-description", {
     descriptionParagraphs: ReadonlyArray<string>;
-}, {}, {}, `book-entry-description-${string}`, `book-entry-description-${string}`, readonly string[]>;
+}, {}, {}, "book-entry-description-", "book-entry-description-", readonly []>;

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

@@ -1,6 +1,6 @@
 import { css, html } from 'element-vir';
-import { colorThemeCssVars } from '../../color-theme/color-theme';
-import { defineBookElement } from '../define-book-element';
+import { colorThemeCssVars } from '../../color-theme/color-theme.js';
+import { defineBookElement } from '../define-book-element.js';
 export const BookEntryDescription = defineBookElement()({
     tagName: 'book-entry-description',
     styles: css `
@@ -24,7 +24,7 @@ export const BookEntryDescription = defineBookElement()({
             margin-top: 8px;
         }
     `,
-    renderCallback({ inputs }) {
+    render({ inputs }) {
         return inputs.descriptionParagraphs.map((paragraph) => {
             return html `
                 <p>${paragraph}</p>

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

@@ -1,17 +1,17 @@
-import { BookPage } from '../../../../data/book-entry/book-page/book-page';
-import { BookPageControl, BookPageControlsValues } from '../../../../data/book-entry/book-page/book-page-controls';
+import { BookPageControl, BookPageControlsValues } from '../../../../data/book-entry/book-page/book-page-controls.js';
+import { BookPage } from '../../../../data/book-entry/book-page/book-page.js';
 export declare const BookPageControls: import("element-vir").DeclarativeElementDefinition<"book-page-controls", {
-    config: BookPage['controls'];
+    config: BookPage["controls"];
     /**
      * If an object (or Record) is given for this input, then each key of the object must correspond
      * to one of the controls from the input config and the value for each key will be the
      * breadcrumbs for that specific config.
      */
     fullUrlBreadcrumbs: ReadonlyArray<string> | Record<string, ReadonlyArray<string>>;
-    currentValues: Record<string, BookPageControl['initValue']>;
+    currentValues: Record<string, BookPageControl["initValue"]>;
 }, {}, {
-    controlValueChange: import("element-vir").DefinedTypedEventNameDefinition<{
+    controlValueChange: import("element-vir").DefineEvent<{
         fullUrlBreadcrumbs: ReadonlyArray<string>;
         newValues: BookPageControlsValues;
     }>;
-}, "book-page-controls-has-controls", `book-page-controls-${string}`, readonly string[]>;
+}, "book-page-controls-has-controls", "book-page-controls-", readonly []>;