typedoc 0.25.7 → 0.25.9

package/dist/lib/models/ReflectionGroup.d.ts

@@ -1,5 +1,5 @@
 import { ReflectionCategory } from "./ReflectionCategory";
-import type { DeclarationReflection, Reflection } from ".";
+import type { CommentDisplayPart, DeclarationReflection, Reflection } from ".";
 import type { Serializer, JSONOutput, Deserializer } from "../serialization";
 /**
  * A group of reflections. All reflections in a group are of the same kind.
@@ -14,6 +14,10 @@ export declare class ReflectionGroup {
      * The title, a string representation of the typescript kind, of this group.
      */
     title: string;
+    /**
+     * User specified description via `@groupDescription`, if specified.
+     */
+    description?: CommentDisplayPart[];
     /**
      * All reflections of this group.
      */

package/dist/lib/models/ReflectionGroup.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReflectionGroup = void 0;
 const ReflectionCategory_1 = require("./ReflectionCategory");
+const comments_1 = require("./comments");
 /**
  * A group of reflections. All reflections in a group are of the same kind.
  *
@@ -33,6 +34,9 @@ class ReflectionGroup {
     toObject(serializer) {
         return {
             title: this.title,
+            description: this.description
+                ? comments_1.Comment.serializeDisplayParts(serializer, this.description)
+                : undefined,
             children: this.children.length > 0
                 ? this.children.map((child) => child.id)
                 : undefined,
@@ -40,6 +44,9 @@ class ReflectionGroup {
         };
     }
     fromObject(de, obj) {
+        if (obj.description) {
+            this.description = comments_1.Comment.deserializeDisplayParts(de, obj.description);
+        }
         if (obj.categories) {
             this.categories = obj.categories.map((catObj) => {
                 const cat = new ReflectionCategory_1.ReflectionCategory(catObj.title);

package/dist/lib/models/comments/comment.d.ts

@@ -76,7 +76,7 @@ export declare class Comment {
     /**
      * Helper utility to clone {@link Comment.summary} or {@link CommentTag.content}
      */
-    static cloneDisplayParts(parts: CommentDisplayPart[]): ({
+    static cloneDisplayParts(parts: readonly CommentDisplayPart[]): ({
         kind: "text";
         text: string;
     } | {
@@ -93,6 +93,15 @@ export declare class Comment {
     /** @hidden no point in showing this signature in api docs */
     static serializeDisplayParts(serializer: Serializer, parts: CommentDisplayPart[] | undefined): JSONOutput.CommentDisplayPart[] | undefined;
     static deserializeDisplayParts(de: Deserializer, parts: JSONOutput.CommentDisplayPart[]): CommentDisplayPart[];
+    /**
+     * Splits the provided parts into a header (first line, as a string)
+     * and body (remaining lines). If the header line contains inline tags
+     * they will be serialized to a string.
+     */
+    static splitPartsToHeaderAndBody(parts: readonly CommentDisplayPart[]): {
+        header: string;
+        body: CommentDisplayPart[];
+    };
     /**
      * The content of the comment which is not associated with a block tag.
      */

package/dist/lib/models/comments/comment.js

@@ -218,6 +218,51 @@ class Comment {
         }
         return result;
     }
+    /**
+     * Splits the provided parts into a header (first line, as a string)
+     * and body (remaining lines). If the header line contains inline tags
+     * they will be serialized to a string.
+     */
+    static splitPartsToHeaderAndBody(parts) {
+        let index = parts.findIndex((part) => {
+            switch (part.kind) {
+                case "text":
+                case "code":
+                    return part.text.includes("\n");
+                case "inline-tag":
+                    return false;
+            }
+        });
+        if (index === -1) {
+            return {
+                header: Comment.combineDisplayParts(parts),
+                body: [],
+            };
+        }
+        // Do not split a code block, stop the header at the end of the previous block
+        if (parts[index].kind === "code") {
+            --index;
+        }
+        if (index === -1) {
+            return { header: "", body: Comment.cloneDisplayParts(parts) };
+        }
+        let header = Comment.combineDisplayParts(parts.slice(0, index));
+        const split = parts[index].text.indexOf("\n");
+        let body;
+        if (split === -1) {
+            header += parts[index].text;
+            body = Comment.cloneDisplayParts(parts.slice(index + 1));
+        }
+        else {
+            header += parts[index].text.substring(0, split);
+            body = Comment.cloneDisplayParts(parts.slice(index));
+            body[0].text = body[0].text.substring(split + 1);
+        }
+        if (!body[0].text) {
+            body.shift();
+        }
+        return { header: header.trim(), body };
+    }
     /**
      * Creates a new Comment instance.
      */

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

@@ -127,7 +127,7 @@ export declare abstract class Reflection {
      * The reflection this reflection is a child of.
      */
     parent?: Reflection;
-    get project(): ProjectReflection;
+    project: ProjectReflection;
     /**
      * The parsed documentation comment attached to this reflection.
      */

package/dist/lib/models/reflections/abstract.js

@@ -35,7 +35,6 @@ var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn,
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Reflection = exports.TraverseProperty = exports.ReflectionFlags = exports.ReflectionFlag = exports.resetReflectionID = void 0;
-const assert_1 = require("assert");
 const comment_1 = require("../comments/comment");
 const utils_1 = require("./utils");
 const kind_1 = require("./kind");
@@ -247,13 +246,9 @@ let Reflection = (() => {
     let _instanceExtraInitializers = [];
     let _parent_decorators;
     let _parent_initializers = [];
+    let _project_decorators;
+    let _project_initializers = [];
     return _a = class Reflection {
-            get project() {
-                if (this.isProject())
-                    return this;
-                (0, assert_1.ok)(this.parent, "Tried to get the project on a reflection not in a project");
-                return this.parent.project;
-            }
             constructor(name, kind, parent) {
                 /**
                  * Unique id of this reflection.
@@ -264,8 +259,10 @@ let Reflection = (() => {
                  * The reflection this reflection is a child of.
                  */
                 this.parent = __runInitializers(this, _parent_initializers, void 0);
+                this.project = __runInitializers(this, _project_initializers, void 0);
                 this.id = REFLECTION_ID++;
                 this.parent = parent;
+                this.project = parent?.project || this;
                 this.name = name;
                 this.kind = kind;
                 // If our parent is external, we are too.
@@ -471,7 +468,9 @@ let Reflection = (() => {
             const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
             _parent_decorators = [general_1.NonEnumerable // So that it doesn't show up in console.log
             ];
+            _project_decorators = [general_1.NonEnumerable];
             __esDecorate(null, null, _parent_decorators, { kind: "field", name: "parent", static: false, private: false, access: { has: obj => "parent" in obj, get: obj => obj.parent, set: (obj, value) => { obj.parent = value; } }, metadata: _metadata }, _parent_initializers, _instanceExtraInitializers);
+            __esDecorate(null, null, _project_decorators, { kind: "field", name: "project", static: false, private: false, access: { has: obj => "project" in obj, get: obj => obj.project, set: (obj, value) => { obj.project = value; } }, metadata: _metadata }, _project_initializers, _instanceExtraInitializers);
             if (_metadata) Object.defineProperty(_a, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         })(),
         _a;

package/dist/lib/models/reflections/declaration.js

@@ -129,18 +129,19 @@ class DeclarationReflection extends container_1.ContainerReflection {
             extendedBy: serializer.toObjectsOptional(this.extendedBy),
             implementedTypes: serializer.toObjectsOptional(this.implementedTypes),
             implementedBy: serializer.toObjectsOptional(this.implementedBy),
+            readme: comments_1.Comment.serializeDisplayParts(serializer, this.readme),
         };
     }
     fromObject(de, obj) {
         super.fromObject(de, obj);
+        if (obj.readme) {
+            this.readme = comments_1.Comment.deserializeDisplayParts(de, obj.readme);
+        }
         // This happens when merging multiple projects together.
         // If updating this, also check ProjectReflection.fromObject.
         if (obj.variant === "project") {
             this.kind = kind_1.ReflectionKind.Module;
             this.packageVersion = obj.packageVersion;
-            if (obj.readme) {
-                this.readme = comments_1.Comment.deserializeDisplayParts(de, obj.readme);
-            }
             de.defer(() => {
                 for (const [id, sid] of Object.entries(obj.symbolIdMap || {})) {
                     const refl = this.project.getReflectionById(de.oldIdToNewId[+id] ?? -1);

package/dist/lib/models/reflections/project.js

@@ -172,17 +172,17 @@ class ProjectReflection extends container_1.ContainerReflection {
         }
         this.reflectionChildren.delete(reflection.id);
         // Remove references from the TS symbol to this reflection.
-        const symbol = this.reflectionIdToSymbolMap.get(reflection.id);
-        if (symbol) {
-            const id = new ReflectionSymbolId_1.ReflectionSymbolId(symbol);
-            const saved = this.symbolToReflectionIdMap.get(id);
+        const symbolId = this.reflectionIdToSymbolIdMap.get(reflection.id);
+        if (symbolId) {
+            const saved = this.symbolToReflectionIdMap.get(symbolId);
             if (saved === reflection.id) {
-                this.symbolToReflectionIdMap.delete(id);
+                this.symbolToReflectionIdMap.delete(symbolId);
             }
             else if (typeof saved === "object") {
                 (0, utils_1.removeIfPresent)(saved, reflection.id);
             }
         }
+        this.reflectionIdToSymbolMap.delete(reflection.id);
         this.reflectionIdToSymbolIdMap.delete(reflection.id);
         delete this.reflections[reflection.id];
     }

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

@@ -0,0 +1,7 @@
+import { RendererComponent } from "../components";
+export declare class SitemapPlugin extends RendererComponent {
+    accessor sitemapBaseUrl: string;
+    initialize(): void;
+    private onRendererBegin;
+    private buildSitemap;
+}

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

@@ -0,0 +1,152 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapPlugin = void 0;
+const path_1 = __importDefault(require("path"));
+const components_1 = require("../components");
+const events_1 = require("../events");
+const DefaultTheme_1 = require("../themes/default/DefaultTheme");
+const utils_1 = require("../../utils");
+const html_1 = require("../../utils/html");
+let SitemapPlugin = (() => {
+    var _SitemapPlugin_sitemapBaseUrl_accessor_storage;
+    let _classDecorators = [(0, components_1.Component)({ name: "sitemap" })];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    let _classSuper = components_1.RendererComponent;
+    let _instanceExtraInitializers = [];
+    let _sitemapBaseUrl_decorators;
+    let _sitemapBaseUrl_initializers = [];
+    var SitemapPlugin = _classThis = class extends _classSuper {
+        constructor() {
+            super(...arguments);
+            _SitemapPlugin_sitemapBaseUrl_accessor_storage.set(this, (__runInitializers(this, _instanceExtraInitializers), __runInitializers(this, _sitemapBaseUrl_initializers, void 0)));
+        }
+        get sitemapBaseUrl() { return __classPrivateFieldGet(this, _SitemapPlugin_sitemapBaseUrl_accessor_storage, "f"); }
+        set sitemapBaseUrl(value) { __classPrivateFieldSet(this, _SitemapPlugin_sitemapBaseUrl_accessor_storage, value, "f"); }
+        initialize() {
+            this.listenTo(this.owner, events_1.RendererEvent.BEGIN, this.onRendererBegin);
+        }
+        onRendererBegin(event) {
+            if (!(this.owner.theme instanceof DefaultTheme_1.DefaultTheme)) {
+                return;
+            }
+            if (event.isDefaultPrevented || !this.sitemapBaseUrl) {
+                return;
+            }
+            this.owner.preRenderAsyncJobs.push((event) => this.buildSitemap(event));
+        }
+        async buildSitemap(event) {
+            // cSpell:words lastmod urlset
+            const sitemapXml = path_1.default.join(event.outputDirectory, "sitemap.xml");
+            const lastmod = new Date(this.owner.renderStartTime).toISOString();
+            const urls = event.urls?.map((url) => {
+                return {
+                    tag: "url",
+                    children: [
+                        {
+                            tag: "loc",
+                            children: new URL(url.url, this.sitemapBaseUrl).toString(),
+                        },
+                        {
+                            tag: "lastmod",
+                            children: lastmod,
+                        },
+                    ],
+                };
+            }) ?? [];
+            const sitemap = `<?xml version="1.0" encoding="UTF-8"?>\n` +
+                stringifyXml({
+                    tag: "urlset",
+                    attr: { xmlns: "http://www.sitemaps.org/schemas/sitemap/0.9" },
+                    children: urls,
+                }) +
+                "\n";
+            await (0, utils_1.writeFile)(sitemapXml, sitemap);
+        }
+    };
+    _SitemapPlugin_sitemapBaseUrl_accessor_storage = new WeakMap();
+    __setFunctionName(_classThis, "SitemapPlugin");
+    (() => {
+        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+        _sitemapBaseUrl_decorators = [(0, utils_1.Option)("sitemapBaseUrl")];
+        __esDecorate(_classThis, null, _sitemapBaseUrl_decorators, { kind: "accessor", name: "sitemapBaseUrl", static: false, private: false, access: { has: obj => "sitemapBaseUrl" in obj, get: obj => obj.sitemapBaseUrl, set: (obj, value) => { obj.sitemapBaseUrl = value; } }, metadata: _metadata }, _sitemapBaseUrl_initializers, _instanceExtraInitializers);
+        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+        SitemapPlugin = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return SitemapPlugin = _classThis;
+})();
+exports.SitemapPlugin = SitemapPlugin;
+function stringifyXml(xml, indent = 0) {
+    const parts = ["\t".repeat(indent), "<", xml.tag];
+    for (const [key, val] of Object.entries(xml.attr || {})) {
+        parts.push(" ", key, '="', (0, html_1.escapeHtml)(val), '"');
+    }
+    parts.push(">");
+    if (typeof xml.children === "string") {
+        parts.push((0, html_1.escapeHtml)(xml.children));
+    }
+    else {
+        for (const child of xml.children) {
+            parts.push("\n");
+            parts.push(stringifyXml(child, indent + 1));
+        }
+        parts.push("\n", "\t".repeat(indent));
+    }
+    parts.push("</", xml.tag, ">");
+    return parts.join("");
+}

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

@@ -2,3 +2,4 @@ export { MarkedPlugin } from "../themes/MarkedPlugin";
 export { AssetsPlugin } from "./AssetsPlugin";
 export { JavascriptIndexPlugin } from "./JavascriptIndexPlugin";
 export { NavigationPlugin } from "./NavigationPlugin";
+export { SitemapPlugin } from "./SitemapPlugin";

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NavigationPlugin = exports.JavascriptIndexPlugin = exports.AssetsPlugin = exports.MarkedPlugin = void 0;
+exports.SitemapPlugin = exports.NavigationPlugin = exports.JavascriptIndexPlugin = exports.AssetsPlugin = exports.MarkedPlugin = void 0;
 var MarkedPlugin_1 = require("../themes/MarkedPlugin");
 Object.defineProperty(exports, "MarkedPlugin", { enumerable: true, get: function () { return MarkedPlugin_1.MarkedPlugin; } });
 var AssetsPlugin_1 = require("./AssetsPlugin");
@@ -9,3 +9,5 @@ var JavascriptIndexPlugin_1 = require("./JavascriptIndexPlugin");
 Object.defineProperty(exports, "JavascriptIndexPlugin", { enumerable: true, get: function () { return JavascriptIndexPlugin_1.JavascriptIndexPlugin; } });
 var NavigationPlugin_1 = require("./NavigationPlugin");
 Object.defineProperty(exports, "NavigationPlugin", { enumerable: true, get: function () { return NavigationPlugin_1.NavigationPlugin; } });
+var SitemapPlugin_1 = require("./SitemapPlugin");
+Object.defineProperty(exports, "SitemapPlugin", { enumerable: true, get: function () { return SitemapPlugin_1.SitemapPlugin; } });

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

@@ -104,7 +104,7 @@ class DefaultTheme extends theme_1.Theme {
             urls.push(new UrlMapping_1.UrlMapping("modules.html", project, this.reflectionTemplate));
             urls.push(new UrlMapping_1.UrlMapping("index.html", project, this.indexTemplate));
         }
-        if (includeHierarchyPage(project)) {
+        if ((0, lib_1.getHierarchyRoots)(project).length) {
             urls.push(new UrlMapping_1.UrlMapping("hierarchy.html", project, this.hierarchyTemplate));
         }
         project.children?.forEach((child) => {
@@ -365,15 +365,3 @@ function shouldShowGroups(reflection, opts) {
     }
     return reflection.comment?.hasModifier("@showGroups") === true;
 }
-function includeHierarchyPage(project) {
-    for (const id in project.reflections) {
-        const refl = project.reflections[id];
-        if (refl.kindOf(models_1.ReflectionKind.ClassOrInterface)) {
-            // Keep this condition in sync with the one in hierarchy.tsx for determining roots
-            if (!(refl.implementedTypes || refl.extendedTypes) && (refl.implementedBy || refl.extendedBy)) {
-                return true;
-            }
-        }
-    }
-    return false;
-}

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

@@ -3,9 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.index = void 0;
 const lib_1 = require("../../lib");
 const utils_1 = require("../../../../utils");
-function renderCategory({ urlTo, icons, getReflectionClasses }, item, prependName = "") {
+function renderCategory({ urlTo, icons, getReflectionClasses, markdown }, 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),
+        item.description && (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" },
+            utils_1.JSX.createElement(utils_1.Raw, { html: markdown(item.description) }))),
         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() }, getReflectionClasses(item)) },
                 icons[item.kind](),

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

@@ -13,7 +13,7 @@ function memberSignatureBody(context, props, { hideSources = false } = {}) {
         props.parameters && props.parameters.length > 0 && (utils_1.JSX.createElement("div", { class: "tsd-parameters" },
             utils_1.JSX.createElement("h4", { class: "tsd-parameters-title" }, "Parameters"),
             utils_1.JSX.createElement("ul", { class: "tsd-parameter-list" }, props.parameters.map((item) => (utils_1.JSX.createElement("li", null,
-                utils_1.JSX.createElement("h5", null,
+                utils_1.JSX.createElement("span", null,
                     context.reflectionFlags(item),
                     !!item.flags.isRest && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
                     utils_1.JSX.createElement("span", { class: "tsd-kind-parameter" }, item.name),

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

@@ -7,7 +7,7 @@ function typeParameters(context, typeParameters) {
         utils_1.JSX.createElement("section", { class: "tsd-panel" },
             utils_1.JSX.createElement("h4", null, "Type Parameters"),
             utils_1.JSX.createElement("ul", { class: "tsd-type-parameter-list" }, typeParameters?.map((item) => (utils_1.JSX.createElement("li", null,
-                utils_1.JSX.createElement("h4", null,
+                utils_1.JSX.createElement("span", null,
                     utils_1.JSX.createElement("a", { id: item.anchor, class: "tsd-anchor" }),
                     item.flags.isConst && utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "const "),
                     item.varianceModifier && (utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" },

package/dist/lib/output/themes/default/templates/hierarchy.d.ts

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

package/dist/lib/output/themes/default/templates/hierarchy.js

@@ -2,8 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hierarchyTemplate = void 0;
 const utils_1 = require("../../../../utils");
-const models_1 = require("../../../../models");
-function fullHierarchy(context, root) {
+const lib_1 = require("../../lib");
+function fullHierarchy(context, root, seen = new Set()) {
+    if (seen.has(root))
+        return;
+    seen.add(root);
     // Note: We don't use root.anchor for the anchor, because those are built on a per page basis.
     // And classes/interfaces get their own page, so all the anchors will be empty anyways.
     // Full name should be safe here, since this list only includes classes/interfaces.
@@ -14,19 +17,15 @@ function fullHierarchy(context, root) {
             root.name),
         utils_1.JSX.createElement("ul", null,
             root.implementedBy?.map((child) => {
-                return child.reflection && fullHierarchy(context, child.reflection);
+                return child.reflection && fullHierarchy(context, child.reflection, seen);
             }),
             root.extendedBy?.map((child) => {
-                return child.reflection && fullHierarchy(context, child.reflection);
+                return child.reflection && fullHierarchy(context, child.reflection, seen);
             }))));
 }
 function hierarchyTemplate(context, props) {
-    // Keep this condition in sync with the one in DefaultTheme.tsx
-    const roots = props.project.getReflectionsByKind(models_1.ReflectionKind.ClassOrInterface)
-        .filter((refl) => !(refl.implementedTypes || refl.extendedTypes) && (refl.implementedBy || refl.extendedBy))
-        .sort((a, b) => a.name.localeCompare(b.name));
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
         utils_1.JSX.createElement("h2", null, "Class Hierarchy"),
-        roots.map((root) => (utils_1.JSX.createElement("ul", { class: "tsd-full-hierarchy" }, fullHierarchy(context, root))))));
+        (0, lib_1.getHierarchyRoots)(props.project).map((root) => (utils_1.JSX.createElement("ul", { class: "tsd-full-hierarchy" }, fullHierarchy(context, root))))));
 }
 exports.hierarchyTemplate = hierarchyTemplate;

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

@@ -1,5 +1,5 @@
 import type { DefaultThemeRenderContext } from "..";
-import { Reflection, TypeParameterReflection } from "../../models";
+import { DeclarationReflection, ProjectReflection, Reflection, TypeParameterReflection } from "../../models";
 import { JSX } from "../../utils";
 export declare function stringify(data: unknown): string;
 export declare function getDisplayName(refl: Reflection): string;
@@ -25,3 +25,4 @@ export declare function camelToTitleCase(text: string): string;
  * Renders the reflection name with an additional `?` if optional.
  */
 export declare function renderName(refl: Reflection): JSX.Element | (string | JSX.Element)[];
+export declare function getHierarchyRoots(project: ProjectReflection): DeclarationReflection[];

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderName = exports.camelToTitleCase = exports.renderTypeParametersSignature = exports.hasTypeParameters = exports.classNames = exports.join = exports.wbr = exports.getKindClass = exports.toStyleClass = exports.getDisplayName = exports.stringify = void 0;
+exports.getHierarchyRoots = exports.renderName = exports.camelToTitleCase = exports.renderTypeParametersSignature = exports.hasTypeParameters = exports.classNames = exports.join = exports.wbr = exports.getKindClass = exports.toStyleClass = exports.getDisplayName = exports.stringify = void 0;
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 function stringify(data) {
@@ -122,3 +122,26 @@ function renderName(refl) {
     return wbr(refl.name);
 }
 exports.renderName = renderName;
+function getHierarchyRoots(project) {
+    const allClasses = project.getReflectionsByKind(models_1.ReflectionKind.ClassOrInterface);
+    const roots = allClasses.filter((refl) => {
+        // If nobody extends this class, there's no possible hierarchy to display.
+        if (!refl.implementedBy && !refl.extendedBy) {
+            return false;
+        }
+        // If we don't extend anything, then we are a root
+        if (!refl.implementedTypes && !refl.extendedTypes) {
+            return true;
+        }
+        // We might still be a root, if our extended/implemented types are not included
+        // in the documentation.
+        const types = [...(refl.implementedTypes || []), ...(refl.extendedTypes || [])];
+        return types.every((type) => !type.visit({
+            reference(ref) {
+                return ref.reflection !== undefined;
+            },
+        }));
+    });
+    return roots.sort((a, b) => a.name.localeCompare(b.name));
+}
+exports.getHierarchyRoots = getHierarchyRoots;

package/dist/lib/serialization/schema.d.ts

@@ -51,10 +51,10 @@ export interface ReflectionSymbolId {
     sourceFileName: string;
     qualifiedName: string;
 }
-export interface ReflectionGroup extends S<M.ReflectionGroup, "title" | "categories"> {
+export interface ReflectionGroup extends S<M.ReflectionGroup, "title" | "description" | "categories"> {
     children?: M.ReflectionGroup["children"][number]["id"][];
 }
-export interface ReflectionCategory extends S<M.ReflectionCategory, "title"> {
+export interface ReflectionCategory extends S<M.ReflectionCategory, "title" | "description"> {
     children?: M.ReflectionCategory["children"][number]["id"][];
 }
 /** @category Reflections */
@@ -78,7 +78,7 @@ export interface ParameterReflection extends Omit<Reflection, "variant">, S<M.Pa
     variant: "param";
 }
 /** @category Reflections */
-export interface DeclarationReflection extends Omit<ContainerReflection, "variant">, S<M.DeclarationReflection, "variant" | "packageVersion" | "sources" | "relevanceBoost" | "type" | "signatures" | "indexSignature" | "defaultValue" | "overwrites" | "inheritedFrom" | "implementationOf" | "extendedTypes" | "extendedBy" | "implementedTypes" | "implementedBy" | "getSignature" | "setSignature" | "typeParameters"> {
+export interface DeclarationReflection extends Omit<ContainerReflection, "variant">, S<M.DeclarationReflection, "variant" | "packageVersion" | "sources" | "relevanceBoost" | "type" | "signatures" | "indexSignature" | "defaultValue" | "overwrites" | "inheritedFrom" | "implementationOf" | "extendedTypes" | "extendedBy" | "implementedTypes" | "implementedBy" | "getSignature" | "setSignature" | "typeParameters" | "readme"> {
 }
 /** @category Reflections */
 export interface TypeParameterReflection extends Omit<Reflection, "variant">, S<M.TypeParameterReflection, "variant" | "type" | "default" | "varianceModifier"> {

package/dist/lib/utils/entry-point.js

@@ -161,7 +161,7 @@ function getEntryPointsForPaths(logger, inputFiles, options, programs = getEntry
         const suggestion = (0, fs_1.isDir)(fileOrDir)
             ? " If you wanted to include files inside this directory, set --entryPointStrategy to expand or specify a glob."
             : "";
-        logger.warn(`The entry point ${(0, paths_1.nicePath)(fileOrDir)} is not included in the program for your provided tsconfig.${suggestion}`);
+        logger.warn(`The entry point ${(0, paths_1.nicePath)(fileOrDir)} is not referenced by the 'files' or 'include' option in your tsconfig.${suggestion}`);
     }
     return entryPoints;
 }

package/dist/lib/utils/events.js

@@ -9,6 +9,7 @@
 // https://github.com/jashkenas/backbone/blob/05fde9e201f7e2137796663081105cd6dad12a98/backbone.js#L119-L374
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventDispatcher = exports.Event = void 0;
+// Priority: Higher number makes the listener be called earlier.
 const uniqueId = (function () {
     const prefixes = Object.create(null);
     return function (prefix) {

package/dist/lib/utils/options/declaration.d.ts

@@ -72,6 +72,7 @@ export interface TypeDocOptionMap {
     excludeProtected: boolean;
     excludeReferences: boolean;
     excludeCategories: string[];
+    maxTypeConversionDepth: number;
     name: string;
     includeVersion: boolean;
     disableSources: boolean;
@@ -95,6 +96,7 @@ export interface TypeDocOptionMap {
     cname: string;
     htmlLang: string;
     githubPages: boolean;
+    sitemapBaseUrl: string;
     cacheBust: boolean;
     gaID: string;
     hideGenerator: boolean;