typedoc 0.23.3 → 0.23.6

package/dist/index.d.ts

@@ -4,7 +4,7 @@ export { resetReflectionID } from "./lib/models/reflections/abstract";
 export { normalizePath } from "./lib/utils/fs";
 export * from "./lib/models";
 export { Converter, Context, type CommentParserConfig } from "./lib/converter";
-export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, } from "./lib/output";
+export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
 export type { RenderTemplate, RendererHooks } from "./lib/output";
 export { ArgumentsReader, BindOption, CommentStyle, JSX, LogLevel, Logger, Options, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, } from "./lib/utils";
 export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, } from "./lib/utils";

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.SerializeEvent = exports.Serializer = exports.JSONOutput = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.normalizePath = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
+exports.TypeScript = exports.SerializeEvent = exports.Serializer = exports.JSONOutput = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.normalizePath = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
 var application_1 = require("./lib/application");
 Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });
 var events_1 = require("./lib/utils/events");
@@ -37,6 +37,7 @@ Object.defineProperty(exports, "Theme", { enumerable: true, get: function () { r
 Object.defineProperty(exports, "PageEvent", { enumerable: true, get: function () { return output_1.PageEvent; } });
 Object.defineProperty(exports, "RendererEvent", { enumerable: true, get: function () { return output_1.RendererEvent; } });
 Object.defineProperty(exports, "MarkdownEvent", { enumerable: true, get: function () { return output_1.MarkdownEvent; } });
+Object.defineProperty(exports, "IndexEvent", { enumerable: true, get: function () { return output_1.IndexEvent; } });
 var utils_1 = require("./lib/utils");
 Object.defineProperty(exports, "ArgumentsReader", { enumerable: true, get: function () { return utils_1.ArgumentsReader; } });
 Object.defineProperty(exports, "BindOption", { enumerable: true, get: function () { return utils_1.BindOption; } });

package/dist/lib/converter/converter.js

@@ -20,6 +20,8 @@ const symbols_1 = require("./symbols");
 const paths_1 = require("../utils/paths");
 const enum_1 = require("../utils/enum");
 const comments_1 = require("./comments");
+const parser_1 = require("./comments/parser");
+const rawLexer_1 = require("./comments/rawLexer");
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  */
@@ -73,7 +75,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         });
         entries.forEach((e) => {
             context.setActiveProgram(e.entryPoint.program);
-            e.context = this.convertExports(context, e.entryPoint.sourceFile, entries.length === 1, e.entryPoint.displayName);
+            e.context = this.convertExports(context, e.entryPoint, entries.length === 1);
         });
         for (const { entryPoint, context } of entries) {
             // active program is already set on context
@@ -84,7 +86,9 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         }
         context.setActiveProgram(undefined);
     }
-    convertExports(context, node, singleEntryPoint, entryName) {
+    convertExports(context, entryPoint, singleEntryPoint) {
+        const node = entryPoint.sourceFile;
+        const entryName = entryPoint.displayName;
         const symbol = getSymbolForModuleLike(context, node);
         let moduleContext;
         const allExports = getExports(context, node, symbol);
@@ -104,6 +108,19 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         }
         else {
             const reflection = context.createDeclarationReflection(index_1.ReflectionKind.Module, symbol, void 0, entryName);
+            if (entryPoint.readmeFile) {
+                const readme = (0, utils_1.readFile)(entryPoint.readmeFile);
+                const comment = (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(readme), context.converter.config, new utils_1.MinimalSourceFile(readme, entryPoint.readmeFile), context.logger);
+                if (comment.blockTags.length || comment.modifierTags.size) {
+                    const ignored = [
+                        ...comment.blockTags.map((tag) => tag.tag),
+                        ...comment.modifierTags,
+                    ];
+                    context.logger.warn(`Block and modifier tags will be ignored within the readme:\n\t${ignored.join("\n\t")}`);
+                }
+                reflection.readme = comment.summary;
+            }
+            reflection.version = entryPoint.version;
             context.finalizeDeclarationReflection(reflection);
             moduleContext = context.withScope(reflection);
         }

package/dist/lib/converter/plugins/LinkResolverPlugin.js

@@ -14,8 +14,9 @@ const declarationReference_1 = require("../comments/declarationReference");
 const ts = require("typescript");
 const utils_1 = require("../../utils");
 const declarationReferenceResolver_1 = require("../comments/declarationReferenceResolver");
+const models_1 = require("../../models");
 const urlPrefix = /^(http|ftp)s?:\/\//;
-const brackets = /\[\[([^\]]+)\]\]/g;
+const brackets = /\[\[(?!include:)([^\]]+)\]\]/g;
 /**
  * A plugin that resolves `{@link Foo}` tags.
  */
@@ -113,6 +114,9 @@ let LinkResolverPlugin = LinkResolverPlugin_1 = class LinkResolverPlugin extends
         for (const tag of comment.blockTags) {
             tag.content = this.processParts(reflection, tag.content, warn);
         }
+        if (reflection instanceof models_1.DeclarationReflection && reflection.readme) {
+            reflection.readme = this.processParts(reflection, reflection.readme, warn);
+        }
     }
     processParts(reflection, parts, warn) {
         return parts.flatMap((part) => this.processPart(reflection, part, warn));

package/dist/lib/converter/plugins/PackagePlugin.d.ts

@@ -1,4 +1,5 @@
 import { ConverterComponent } from "../components";
+import { EntryPointStrategy } from "../../utils";
 /**
  * A handler that tries to find the package.json and readme.md files of the
  * current project.
@@ -6,6 +7,7 @@ import { ConverterComponent } from "../components";
 export declare class PackagePlugin extends ConverterComponent {
     readme: string;
     includeVersion: boolean;
+    entryPointStrategy: EntryPointStrategy;
     /**
      * The file name of the found readme.md file.
      */

package/dist/lib/converter/plugins/PackagePlugin.js

@@ -102,7 +102,11 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
                     project.name = `${project.name} - v${packageInfo.version}`;
                 }
                 else {
-                    context.logger.warn("--includeVersion was specified, but package.json does not specify a version.");
+                    // since not all monorepo specifies a meaningful version to the main package.json
+                    // this warning should be optional
+                    if (this.entryPointStrategy !== utils_1.EntryPointStrategy.Packages) {
+                        context.logger.warn("--includeVersion was specified, but package.json does not specify a version.");
+                    }
                 }
             }
         }
@@ -112,7 +116,11 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
                 project.name = "Documentation";
             }
             if (this.includeVersion) {
-                context.logger.warn("--includeVersion was specified, but no package.json was found. Not adding package version to the documentation.");
+                // since not all monorepo specifies a meaningful version to the main package.json
+                // this warning should be optional
+                if (this.entryPointStrategy !== utils_1.EntryPointStrategy.Packages) {
+                    context.logger.warn("--includeVersion was specified, but no package.json was found. Not adding package version to the documentation.");
+                }
             }
         }
     }
@@ -123,6 +131,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("includeVersion")
 ], PackagePlugin.prototype, "includeVersion", void 0);
+__decorate([
+    (0, utils_1.BindOption)("entryPointStrategy")
+], PackagePlugin.prototype, "entryPointStrategy", void 0);
 PackagePlugin = __decorate([
     (0, components_1.Component)({ name: "package" })
 ], PackagePlugin);

package/dist/lib/models/reflections/declaration.d.ts

@@ -5,6 +5,7 @@ import { ContainerReflection } from "./container";
 import type { SignatureReflection } from "./signature";
 import type { TypeParameterReflection } from "./type-parameter";
 import type { Serializer, JSONOutput } from "../../serialization";
+import type { CommentDisplayPart } from "../comments";
 /**
  * Stores hierarchical type data.
  *
@@ -109,6 +110,14 @@ export declare class DeclarationReflection extends ContainerReflection {
      * rendered in templates.
      */
     typeHierarchy?: DeclarationHierarchy;
+    /**
+     * The contents of the readme file of the module when found.
+     */
+    readme?: CommentDisplayPart[];
+    /**
+     * The version of the module when found.
+     */
+    version?: string;
     hasGetterOrSetter(): boolean;
     getAllSignatures(): SignatureReflection[];
     /** @internal */

package/dist/lib/output/events.d.ts

@@ -1,6 +1,7 @@
 import { Event } from "../utils/events";
 import type { ProjectReflection } from "../models/reflections/project";
 import type { RenderTemplate, UrlMapping } from "./models/UrlMapping";
+import type { DeclarationReflection } from "../models";
 /**
  * An event emitted by the {@link Renderer} class at the very beginning and
  * ending of the entire rendering process.
@@ -109,3 +110,45 @@ export declare class MarkdownEvent extends Event {
     static readonly PARSE = "parseMarkdown";
     constructor(name: string, originalText: string, parsedText: string);
 }
+/**
+ * An event emitted when the search index is being prepared.
+ */
+export declare class IndexEvent extends Event {
+    /**
+     * Triggered on the renderer when the search index is being prepared.
+     * @event
+     */
+    static readonly PREPARE_INDEX = "prepareIndex";
+    /**
+     * May be filtered by plugins to reduce the results available.
+     * Additional items *should not* be added to this array.
+     *
+     * If you remove an index from this array, you must also remove the
+     * same index from {@link searchFields}. The {@link removeResult} helper
+     * will do this for you.
+     */
+    searchResults: DeclarationReflection[];
+    /**
+     * Additional search fields to be used when creating the search index.
+     * `name` and `comment` may be specified to overwrite TypeDoc's search fields.
+     *
+     * Do not use `id` as a custom search field.
+     */
+    searchFields: Record<string, string>[];
+    /**
+     * Weights for the fields defined in `searchFields`. The default will weight
+     * `name` as 10x more important than comment content.
+     *
+     * If a field added to {@link searchFields} is not added to this object, it
+     * will **not** be searchable.
+     *
+     * Do not replace this object, instead, set new properties on it for custom search
+     * fields added by your plugin.
+     */
+    readonly searchFieldWeights: Record<string, number>;
+    /**
+     * Remove a search result by index.
+     */
+    removeResult(index: number): void;
+    constructor(name: string, searchResults: DeclarationReflection[]);
+}

package/dist/lib/output/events.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MarkdownEvent = exports.PageEvent = exports.RendererEvent = void 0;
+exports.IndexEvent = exports.MarkdownEvent = exports.PageEvent = exports.RendererEvent = void 0;
 const Path = require("path");
 const events_1 = require("../utils/events");
 /**
@@ -82,3 +82,40 @@ exports.MarkdownEvent = MarkdownEvent;
  * @event
  */
 MarkdownEvent.PARSE = "parseMarkdown";
+/**
+ * An event emitted when the search index is being prepared.
+ */
+class IndexEvent extends events_1.Event {
+    constructor(name, searchResults) {
+        super(name);
+        /**
+         * Weights for the fields defined in `searchFields`. The default will weight
+         * `name` as 10x more important than comment content.
+         *
+         * If a field added to {@link searchFields} is not added to this object, it
+         * will **not** be searchable.
+         *
+         * Do not replace this object, instead, set new properties on it for custom search
+         * fields added by your plugin.
+         */
+        this.searchFieldWeights = {
+            name: 10,
+            comment: 1,
+        };
+        this.searchResults = searchResults;
+        this.searchFields = Array.from({ length: this.searchResults.length }, () => ({}));
+    }
+    /**
+     * Remove a search result by index.
+     */
+    removeResult(index) {
+        this.searchResults.splice(index, 1);
+        this.searchFields.splice(index, 1);
+    }
+}
+exports.IndexEvent = IndexEvent;
+/**
+ * Triggered on the renderer when the search index is being prepared.
+ * @event
+ */
+IndexEvent.PREPARE_INDEX = "prepareIndex";

package/dist/lib/output/index.d.ts

@@ -1,4 +1,4 @@
-export { PageEvent, RendererEvent, MarkdownEvent } from "./events";
+export { PageEvent, RendererEvent, MarkdownEvent, IndexEvent } from "./events";
 export { UrlMapping } from "./models/UrlMapping";
 export type { RenderTemplate } from "./models/UrlMapping";
 export { Renderer } from "./renderer";

package/dist/lib/output/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Theme = exports.Renderer = exports.UrlMapping = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = void 0;
+exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Theme = exports.Renderer = exports.UrlMapping = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = void 0;
 var events_1 = require("./events");
 Object.defineProperty(exports, "PageEvent", { enumerable: true, get: function () { return events_1.PageEvent; } });
 Object.defineProperty(exports, "RendererEvent", { enumerable: true, get: function () { return events_1.RendererEvent; } });
 Object.defineProperty(exports, "MarkdownEvent", { enumerable: true, get: function () { return events_1.MarkdownEvent; } });
+Object.defineProperty(exports, "IndexEvent", { enumerable: true, get: function () { return events_1.IndexEvent; } });
 var UrlMapping_1 = require("./models/UrlMapping");
 Object.defineProperty(exports, "UrlMapping", { enumerable: true, get: function () { return UrlMapping_1.UrlMapping; } });
 var renderer_1 = require("./renderer");

package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts

@@ -5,6 +5,7 @@ import { RendererComponent } from "../components";
  * The resulting javascript file can be used to build a simple search function.
  */
 export declare class JavascriptIndexPlugin extends RendererComponent {
+    searchComments: boolean;
     /**
      * Create a new JavascriptIndexPlugin instance.
      */
@@ -15,4 +16,5 @@ export declare class JavascriptIndexPlugin extends RendererComponent {
      * @param event  An event object describing the current render operation.
      */
     private onRendererBegin;
+    private getCommentSearchText;
 }

package/dist/lib/output/plugins/JavascriptIndexPlugin.js

@@ -41,20 +41,32 @@ let JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.Ren
         }
         const rows = [];
         const kinds = {};
-        for (const reflection of event.project.getReflectionsByKind(models_1.ReflectionKind.All)) {
-            if (!(reflection instanceof models_1.DeclarationReflection)) {
-                continue;
-            }
-            if (!reflection.url ||
-                !reflection.name ||
-                reflection.flags.isExternal) {
+        const initialSearchResults = Object.values(event.project.reflections).filter((refl) => {
+            return (refl instanceof models_1.DeclarationReflection &&
+                refl.url &&
+                refl.name &&
+                !refl.flags.isExternal);
+        });
+        const indexEvent = new events_1.IndexEvent(events_1.IndexEvent.PREPARE_INDEX, initialSearchResults);
+        this.owner.trigger(indexEvent);
+        if (indexEvent.isDefaultPrevented) {
+            return;
+        }
+        const builder = new lunr_1.Builder();
+        builder.pipeline.add(lunr_1.trimmer);
+        builder.ref("id");
+        for (const [key, boost] of Object.entries(indexEvent.searchFieldWeights)) {
+            builder.field(key, { boost });
+        }
+        for (const reflection of indexEvent.searchResults) {
+            if (!reflection.url) {
                 continue;
             }
-            let parent = reflection.parent;
             const boost = reflection.relevanceBoost ?? 1;
             if (boost <= 0) {
                 continue;
             }
+            let parent = reflection.parent;
             if (parent instanceof models_1.ProjectReflection) {
                 parent = undefined;
             }
@@ -62,26 +74,22 @@ let JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.Ren
                 kinds[reflection.kind] = plugins_1.GroupPlugin.getKindSingular(reflection.kind);
             }
             const row = {
-                id: rows.length,
                 kind: reflection.kind,
                 name: reflection.name,
                 url: reflection.url,
                 classes: reflection.cssClasses,
             };
-            if (boost !== 1) {
-                row.boost = boost;
-            }
             if (parent) {
                 row.parent = parent.getFullName();
             }
+            builder.add({
+                name: reflection.name,
+                comment: this.getCommentSearchText(reflection),
+                ...indexEvent.searchFields[rows.length],
+                id: rows.length,
+            }, { boost });
             rows.push(row);
         }
-        const builder = new lunr_1.Builder();
-        builder.pipeline.add(lunr_1.trimmer);
-        builder.ref("id");
-        builder.field("name", { boost: 10 });
-        builder.field("parent");
-        rows.forEach((row) => builder.add(row));
         const index = builder.build();
         const jsonFileName = Path.join(event.outputDirectory, "assets", "search.js");
         const jsonData = JSON.stringify({
@@ -91,7 +99,31 @@ let JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.Ren
         });
         (0, utils_1.writeFileSync)(jsonFileName, `window.searchData = JSON.parse(${JSON.stringify(jsonData)});`);
     }
+    getCommentSearchText(reflection) {
+        if (!this.searchComments)
+            return;
+        const comments = [];
+        if (reflection.comment)
+            comments.push(reflection.comment);
+        reflection.signatures?.forEach((s) => s.comment && comments.push(s.comment));
+        reflection.getSignature?.comment &&
+            comments.push(reflection.getSignature.comment);
+        reflection.setSignature?.comment &&
+            comments.push(reflection.setSignature.comment);
+        if (!comments.length) {
+            return;
+        }
+        return comments
+            .flatMap((c) => {
+            return [...c.summary, ...c.blockTags.flatMap((t) => t.content)];
+        })
+            .map((part) => part.text)
+            .join("\n");
+    }
 };
+__decorate([
+    (0, utils_1.BindOption)("searchInComments")
+], JavascriptIndexPlugin.prototype, "searchComments", void 0);
 JavascriptIndexPlugin = __decorate([
     (0, components_1.Component)({ name: "javascript-index" })
 ], JavascriptIndexPlugin);

package/dist/lib/output/renderer.d.ts

@@ -73,6 +73,10 @@ export interface RendererHooks {
  *  * {@link Renderer.EVENT_END}<br>
  *    Triggered after the renderer has written all documents. The listener receives
  *    an instance of {@link RendererEvent}.
+ *
+ * * {@link Renderer.EVENT_PREPARE_INDEX}<br>
+ *    Triggered when the JavascriptIndexPlugin is preparing the search index. Listeners receive
+ *    an instance of {@link IndexEvent}.
  */
 export declare class Renderer extends ChildableComponent<Application, RendererComponent> {
     private themes;
@@ -85,6 +89,8 @@ export declare class Renderer extends ChildableComponent<Application, RendererCo
     static readonly EVENT_BEGIN = "beginRender";
     /** @event */
     static readonly EVENT_END = "endRender";
+    /** @event */
+    static readonly EVENT_PREPARE_INDEX = "prepareIndex";
     /**
      * The theme that is used to render the documentation.
      */

package/dist/lib/output/renderer.js

@@ -53,6 +53,10 @@ const icon_1 = require("./themes/default/partials/icon");
  *  * {@link Renderer.EVENT_END}<br>
  *    Triggered after the renderer has written all documents. The listener receives
  *    an instance of {@link RendererEvent}.
+ *
+ * * {@link Renderer.EVENT_PREPARE_INDEX}<br>
+ *    Triggered when the JavascriptIndexPlugin is preparing the search index. Listeners receive
+ *    an instance of {@link IndexEvent}.
  */
 let Renderer = class Renderer extends component_1.ChildableComponent {
     constructor() {
@@ -257,6 +261,8 @@ Renderer.EVENT_END_PAGE = events_1.PageEvent.END;
 Renderer.EVENT_BEGIN = events_1.RendererEvent.BEGIN;
 /** @event */
 Renderer.EVENT_END = events_1.RendererEvent.END;
+/** @event */
+Renderer.EVENT_PREPARE_INDEX = events_1.IndexEvent.PREPARE_INDEX;
 __decorate([
     (0, utils_1.BindOption)("theme")
 ], Renderer.prototype, "themeName", void 0);

package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts

@@ -6,6 +6,7 @@ export declare class DefaultThemeRenderContext {
     private theme;
     options: Options;
     constructor(theme: DefaultTheme, options: Options);
+    icons: Record<"search" | "anchor" | import("../../../models").ReflectionKind | "checkbox" | "chevronDown" | "menu" | "chevronSmall", () => import("../../../utils/jsx.elements").JsxElement>;
     hook: (name: keyof RendererHooks) => import("../../../utils/jsx.elements").JsxElement[];
     /** Avoid this in favor of urlTo if possible */
     relativeURL: (url: string | undefined) => string | undefined;
@@ -38,6 +39,9 @@ export declare class DefaultThemeRenderContext {
     members: (props: import("../../../models").ContainerReflection) => import("../../../utils/jsx.elements").JsxElement;
     membersGroup: (group: import("../../../models").ReflectionGroup) => import("../../../utils/jsx.elements").JsxElement;
     navigation: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
+    settings: () => import("../../../utils/jsx.elements").JsxElement;
+    primaryNavigation: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
+    secondaryNavigation: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement | undefined;
     parameter: (props: import("../../../models").DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
     toolbar: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     type: (type: import("../../../models").Type | undefined) => import("../../../utils/jsx.elements").JsxElement;

package/dist/lib/output/themes/default/DefaultThemeRenderContext.js

@@ -9,6 +9,7 @@ const comment_1 = require("./partials/comment");
 const footer_1 = require("./partials/footer");
 const header_1 = require("./partials/header");
 const hierarchy_1 = require("./partials/hierarchy");
+const icon_1 = require("./partials/icon");
 const member_1 = require("./partials/member");
 const member_declaration_1 = require("./partials/member.declaration");
 const member_getterSetter_1 = require("./partials/member.getterSetter");
@@ -33,6 +34,7 @@ function bind(fn, first) {
 class DefaultThemeRenderContext {
     constructor(theme, options) {
         this.theme = theme;
+        this.icons = icon_1.icons;
         this.hook = (name) => this.theme.owner.hooks.emit(name, this);
         /** Avoid this in favor of urlTo if possible */
         this.relativeURL = (url) => {
@@ -66,6 +68,9 @@ class DefaultThemeRenderContext {
         this.members = bind(members_1.members, this);
         this.membersGroup = bind(members_group_1.membersGroup, this);
         this.navigation = bind(navigation_1.navigation, this);
+        this.settings = bind(navigation_1.settings, this);
+        this.primaryNavigation = bind(navigation_1.primaryNavigation, this);
+        this.secondaryNavigation = bind(navigation_1.secondaryNavigation, this);
         this.parameter = bind(parameter_1.parameter, this);
         this.toolbar = bind(toolbar_1.toolbar, this);
         this.type = bind(type_1.type, this);

package/dist/lib/output/themes/default/partials/anchor-icon.d.ts

@@ -1,2 +1,3 @@
 import { JSX } from "../../../../utils";
-export declare const anchorIcon: (anchor: string | undefined) => JSX.Element;
+import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
+export declare const anchorIcon: (context: DefaultThemeRenderContext, anchor: string | undefined) => JSX.Element;

package/dist/lib/output/themes/default/partials/anchor-icon.js

@@ -2,6 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.anchorIcon = void 0;
 const utils_1 = require("../../../../utils");
-const icon_1 = require("./icon");
-const anchorIcon = (anchor) => (utils_1.JSX.createElement("a", { href: `#${anchor}`, "aria-label": "Permalink", class: "tsd-anchor-icon" }, icon_1.icons.anchor()));
+const anchorIcon = (context, anchor) => (utils_1.JSX.createElement("a", { href: `#${anchor}`, "aria-label": "Permalink", class: "tsd-anchor-icon" }, context.icons.anchor()));
 exports.anchorIcon = anchorIcon;

package/dist/lib/output/themes/default/partials/header.d.ts

@@ -1,5 +1,5 @@
 import { JSX } from "../../../../utils";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import type { PageEvent } from "../../../events";
-import type { Reflection } from "../../../../models";
+import { Reflection } from "../../../../models";
 export declare const header: (context: DefaultThemeRenderContext, props: PageEvent<Reflection>) => JSX.Element;

package/dist/lib/output/themes/default/partials/header.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.header = void 0;
 const lib_1 = require("../../lib");
 const utils_1 = require("../../../../utils");
+const models_1 = require("../../../../models");
 const header = (context, props) => {
     const HeadingLevel = props.model.isProject() ? "h2" : "h1";
     return (utils_1.JSX.createElement("div", { class: "tsd-page-title" },
@@ -10,6 +11,9 @@ const header = (context, props) => {
         utils_1.JSX.createElement(HeadingLevel, null,
             props.model.kindString !== "Project" && `${props.model.kindString ?? ""} `,
             props.model.name,
+            props.model instanceof models_1.DeclarationReflection &&
+                props.model.version !== undefined &&
+                ` - v${props.model.version}`,
             (0, lib_1.hasTypeParameters)(props.model) && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                 "<",
                 (0, lib_1.join)(", ", props.model.typeParameters, (item) => item.name),

package/dist/lib/output/themes/default/partials/icon.d.ts

@@ -1,6 +1,4 @@
 import { ReflectionKind } from "../../../../models";
 import { JSX } from "../../../../utils";
-declare type UtilityIcons = Record<"chevronDown" | "checkbox" | "menu" | "search" | "chevronSmall" | "anchor", () => JSX.Element>;
 export declare function clearSeenIconCache(): void;
-export declare const icons: Record<ReflectionKind, () => JSX.Element> & UtilityIcons;
-export {};
+export declare const icons: Record<ReflectionKind | "chevronDown" | "checkbox" | "menu" | "search" | "chevronSmall" | "anchor", () => JSX.Element>;

package/dist/lib/output/themes/default/partials/index.d.ts

@@ -1,4 +1,4 @@
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { JSX } from "../../../../utils";
-import type { ContainerReflection } from "../../../../models";
+import { ContainerReflection } from "../../../../models";
 export declare function index(context: DefaultThemeRenderContext, props: ContainerReflection): JSX.Element;

package/dist/lib/output/themes/default/partials/index.js

@@ -3,13 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.index = void 0;
 const lib_1 = require("../../lib");
 const utils_1 = require("../../../../utils");
-const icon_1 = require("./icon");
-function renderCategory({ urlTo }, item, prependName = "") {
+const models_1 = require("../../../../models");
+function renderCategory({ urlTo, icons }, item, prependName = "") {
     return (utils_1.JSX.createElement("section", { class: "tsd-index-section" },
         utils_1.JSX.createElement("h3", { class: "tsd-index-heading" }, prependName ? `${prependName} - ${item.title}` : item.title),
         utils_1.JSX.createElement("div", { class: "tsd-index-list" }, item.children.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             utils_1.JSX.createElement("a", { href: urlTo(item), class: (0, lib_1.classNames)({ "tsd-index-link": true, deprecated: item.isDeprecated() }, item.cssClasses) },
-                icon_1.icons[item.kind](),
+                icons[item.kind](),
                 utils_1.JSX.createElement("span", null, item.name ? (0, lib_1.wbr)(item.name) : utils_1.JSX.createElement("em", null, (0, lib_1.wbr)(item.kindString)))),
             "\n"))))));
 }
@@ -28,7 +28,7 @@ function index(context, props) {
         content = (utils_1.JSX.createElement("details", { class: "tsd-index-content tsd-index-accordion", open: true },
             utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary tsd-index-summary" },
                 utils_1.JSX.createElement("h5", { class: "tsd-index-heading uppercase", role: "button", "aria-expanded": "false", tabIndex: 0 },
-                    icon_1.icons.chevronSmall(),
+                    context.icons.chevronSmall(),
                     " Index")),
             utils_1.JSX.createElement("div", { class: "tsd-accordion-details" }, content)));
     }
@@ -37,7 +37,13 @@ function index(context, props) {
             utils_1.JSX.createElement("h3", { class: "tsd-index-heading uppercase" }, "Index"),
             content));
     }
-    return (utils_1.JSX.createElement("section", { class: "tsd-panel-group tsd-index-group" },
-        utils_1.JSX.createElement("section", { class: "tsd-panel tsd-index-panel" }, content)));
+    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+        props instanceof models_1.DeclarationReflection &&
+            props.kind === models_1.ReflectionKind.Module &&
+            props.readme?.length !== 0 && (utils_1.JSX.createElement("section", { class: "tsd-panel-group" },
+            utils_1.JSX.createElement("section", { class: "tsd-panel tsd-typography" },
+                utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown((0, lib_1.displayPartsToMarkdown)(props.readme || [], context.urlTo)) })))),
+        utils_1.JSX.createElement("section", { class: "tsd-panel-group tsd-index-group" },
+            utils_1.JSX.createElement("section", { class: "tsd-panel tsd-index-panel" }, content))));
 }
 exports.index = index;

package/dist/lib/output/themes/default/partials/member.js

@@ -10,7 +10,7 @@ const member = (context, props) => (utils_1.JSX.createElement("section", { class
     !!props.name && (utils_1.JSX.createElement("h3", { class: "tsd-anchor-link" },
         (0, lib_1.renderFlags)(props.flags, props.comment),
         utils_1.JSX.createElement("span", { class: (0, lib_1.classNames)({ deprecated: props.isDeprecated() }) }, (0, lib_1.wbr)(props.name)),
-        (0, anchor_icon_1.anchorIcon)(props.anchor))),
+        (0, anchor_icon_1.anchorIcon)(context, props.anchor))),
     props.signatures
         ? context.memberSignatures(props)
         : props.hasGetterOrSetter()

package/dist/lib/output/themes/default/partials/navigation.d.ts

@@ -3,3 +3,6 @@ import { JSX } from "../../../../utils";
 import type { PageEvent } from "../../../events";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 export declare function navigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;
+export declare function settings(context: DefaultThemeRenderContext): JSX.Element;
+export declare function primaryNavigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;
+export declare function secondaryNavigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element | undefined;