typedoc 0.23.26 → 0.24.0-beta.1

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

@@ -1,16 +1,16 @@
 import type { RendererHooks } from "../..";
-import { CommentDisplayPart, ReferenceType, Reflection } from "../../../models";
+import { CommentDisplayPart, DeclarationReflection, ReferenceType, Reflection, ReflectionKind } from "../../../models";
 import type { NeverIfInternal, Options } from "../../../utils";
 import type { DefaultTheme } from "./DefaultTheme";
 export declare class DefaultThemeRenderContext {
     private theme;
     options: Options;
     constructor(theme: DefaultTheme, options: Options);
-    icons: Record<"anchor" | import("../../../models").ReflectionKind | "search" | "checkbox" | "chevronDown" | "menu" | "chevronSmall", () => import("../../../utils/jsx.elements").JsxElement>;
+    icons: Record<"search" | "anchor" | 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;
-    urlTo: (reflection: Reflection) => string;
+    urlTo: (reflection: Reflection) => string | undefined;
     markdown: (md: readonly CommentDisplayPart[] | NeverIfInternal<string | undefined>) => string;
     /**
      * Using this method will repeat work already done, instead of calling it, use `type.externalUrl`.
@@ -18,6 +18,7 @@ export declare class DefaultThemeRenderContext {
      * Will be removed in 0.24.
      */
     attemptExternalResolution: (type: NeverIfInternal<ReferenceType>) => string | undefined;
+    getReflectionClasses: (reflection: DeclarationReflection) => string;
     reflectionTemplate: (props: import("../..").PageEvent<import("../../../models").ContainerReflection>) => import("../../../utils/jsx.elements").JsxElement;
     indexTemplate: (props: import("../..").PageEvent<import("../../../models").ProjectReflection>) => import("../../../utils/jsx.elements").JsxElement;
     defaultLayout: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
@@ -28,9 +29,9 @@ export declare class DefaultThemeRenderContext {
     header: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     hierarchy: (props: import("../../../models").DeclarationHierarchy | undefined) => import("../../../utils/jsx.elements").JsxElement | undefined;
     index: (props: import("../../../models").ContainerReflection) => import("../../../utils/jsx.elements").JsxElement;
-    member: (props: import("../../../models").DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
-    memberDeclaration: (props: import("../../../models").DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
-    memberGetterSetter: (props: import("../../../models").DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
+    member: (props: DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
+    memberDeclaration: (props: DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
+    memberGetterSetter: (props: DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
     memberReference: (props: import("../../../models").ReferenceReflection) => import("../../../utils/jsx.elements").JsxElement;
     memberSignatureBody: (r_0: import("../../../models").SignatureReflection, r_1?: {
         hideSources?: boolean | undefined;
@@ -39,8 +40,8 @@ export declare class DefaultThemeRenderContext {
         hideName?: boolean | undefined;
         arrowStyle?: boolean | undefined;
     } | undefined) => import("../../../utils/jsx.elements").JsxElement;
-    memberSignatures: (props: import("../../../models").DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
-    memberSources: (props: import("../../../models").SignatureReflection | import("../../../models").DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
+    memberSignatures: (props: DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
+    memberSources: (props: import("../../../models").SignatureReflection | DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
     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;
@@ -48,7 +49,7 @@ export declare class DefaultThemeRenderContext {
     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;
+    parameter: (props: 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;
     typeAndParent: (props: import("../../../models").Type) => import("../../../utils/jsx.elements").JsxElement;

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultThemeRenderContext = void 0;
 const models_1 = require("../../../models");
+const lib_1 = require("../lib");
 const default_1 = require("./layouts/default");
 const partials_1 = require("./partials");
 const analytics_1 = require("./partials/analytics");
@@ -44,7 +45,7 @@ class DefaultThemeRenderContext {
         this.urlTo = (reflection) => this.relativeURL(reflection.url);
         this.markdown = (md) => {
             if (md instanceof Array) {
-                return this.theme.markedPlugin.parseMarkdown(models_1.Comment.displayPartsToMarkdown(md, this.urlTo));
+                return this.theme.markedPlugin.parseMarkdown((0, lib_1.displayPartsToMarkdown)(md, this.urlTo));
             }
             return md ? this.theme.markedPlugin.parseMarkdown(md) : "";
         };
@@ -56,6 +57,10 @@ class DefaultThemeRenderContext {
         this.attemptExternalResolution = (type) => {
             return type.externalUrl;
         };
+        this.getReflectionClasses = (reflection) => {
+            const filters = this.options.getValue("visibilityFilters");
+            return getReflectionClasses(reflection, filters);
+        };
         this.reflectionTemplate = bind(reflection_1.reflectionTemplate, this);
         this.indexTemplate = bind(templates_1.indexTemplate, this);
         this.defaultLayout = bind(default_1.defaultLayout, this);
@@ -90,3 +95,52 @@ class DefaultThemeRenderContext {
     }
 }
 exports.DefaultThemeRenderContext = DefaultThemeRenderContext;
+function getReflectionClasses(reflection, filters) {
+    const classes = [];
+    classes.push(toStyleClass("tsd-kind-" + models_1.ReflectionKind[reflection.kind]));
+    if (reflection.parent &&
+        reflection.parent instanceof models_1.DeclarationReflection) {
+        classes.push(toStyleClass(`tsd-parent-kind-${models_1.ReflectionKind[reflection.parent.kind]}`));
+    }
+    // Filter classes should match up with the settings function in
+    // partials/navigation.tsx.
+    for (const key of Object.keys(filters)) {
+        if (key === "inherited") {
+            if (reflection.inheritedFrom) {
+                classes.push("tsd-is-inherited");
+            }
+        }
+        else if (key === "protected") {
+            if (reflection.flags.isProtected) {
+                classes.push("tsd-is-protected");
+            }
+        }
+        else if (key === "private") {
+            if (reflection.flags.isPrivate) {
+                classes.push("tsd-is-private");
+            }
+        }
+        else if (key === "external") {
+            if (reflection.flags.isExternal) {
+                classes.push("tsd-is-external");
+            }
+        }
+        else if (key.startsWith("@")) {
+            if (key === "@deprecated") {
+                if (reflection.isDeprecated()) {
+                    classes.push(toStyleClass(`tsd-is-${key.substring(1)}`));
+                }
+            }
+            else if (reflection.comment?.hasModifier(key) ||
+                reflection.comment?.getTag(key)) {
+                classes.push(toStyleClass(`tsd-is-${key.substring(1)}`));
+            }
+        }
+    }
+    return classes.join(" ");
+}
+function toStyleClass(str) {
+    return str
+        .replace(/(\w)([A-Z])/g, (_m, m1, m2) => m1 + "-" + m2)
+        .toLowerCase();
+}

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

@@ -9,11 +9,8 @@ const header = (context, props) => {
     return (utils_1.JSX.createElement("div", { class: "tsd-page-title" },
         !!props.model.parent && utils_1.JSX.createElement("ul", { class: "tsd-breadcrumb" }, context.breadcrumb(props.model)),
         utils_1.JSX.createElement(HeadingLevel, null,
-            props.model.kind !== models_1.ReflectionKind.Project && `${props.model.kindString ?? ""} `,
-            props.model.name,
-            props.model instanceof models_1.DeclarationReflection &&
-                props.model.version !== undefined &&
-                ` - v${props.model.version}`,
+            props.model.kind !== models_1.ReflectionKind.Project && `${models_1.ReflectionKind.singularString(props.model.kind)} `,
+            (0, lib_1.getDisplayName)(context, props.model),
             (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/index.js

@@ -4,11 +4,11 @@ exports.index = void 0;
 const lib_1 = require("../../lib");
 const utils_1 = require("../../../../utils");
 const models_1 = require("../../../../models");
-function renderCategory({ urlTo, icons }, item, prependName = "") {
+function renderCategory({ urlTo, icons, getReflectionClasses }, 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) },
+            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](),
                 utils_1.JSX.createElement("span", null, (0, lib_1.renderName)(item))),
             "\n"))))));

package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts

@@ -1,4 +1,4 @@
-import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-import { JSX } from "../../../../utils";
 import type { DeclarationReflection } from "../../../../models";
+import { JSX } from "../../../../utils";
+import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 export declare const memberGetterSetter: (context: DefaultThemeRenderContext, props: DeclarationReflection) => JSX.Element;

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

@@ -2,8 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.memberGetterSetter = void 0;
 const utils_1 = require("../../../../utils");
+const lib_1 = require("../../lib");
 const memberGetterSetter = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-    utils_1.JSX.createElement("ul", { class: "tsd-signatures " + props.cssClasses },
+    utils_1.JSX.createElement("ul", { class: (0, lib_1.classNames)({
+            "tsd-signatures": true,
+        }, context.getReflectionClasses(props)) },
         !!props.getSignature && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             utils_1.JSX.createElement("li", { class: "tsd-signature", id: props.getSignature.anchor },
                 utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "get"),

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

@@ -5,7 +5,7 @@ const lib_1 = require("../../lib");
 const utils_1 = require("../../../../utils");
 const models_1 = require("../../../../models");
 const anchor_icon_1 = require("./anchor-icon");
-const member = (context, props) => (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-member " + props.cssClasses },
+const member = (context, props) => (utils_1.JSX.createElement("section", { class: (0, lib_1.classNames)({ "tsd-panel": true, "tsd-member": true }, context.getReflectionClasses(props)) },
     utils_1.JSX.createElement("a", { id: props.anchor, class: "tsd-anchor" }),
     !!props.name && (utils_1.JSX.createElement("h3", { class: "tsd-anchor-link" },
         (0, lib_1.renderFlags)(props.flags, props.comment),

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

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.memberSignatures = void 0;
 const utils_1 = require("../../../../utils");
 const anchor_icon_1 = require("./anchor-icon");
+const lib_1 = require("../../lib");
 const memberSignatures = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-    utils_1.JSX.createElement("ul", { class: "tsd-signatures " + props.cssClasses }, props.signatures?.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+    utils_1.JSX.createElement("ul", { class: (0, lib_1.classNames)({ "tsd-signatures": true }, context.getReflectionClasses(props)) }, props.signatures?.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
         utils_1.JSX.createElement("li", { class: "tsd-signature tsd-anchor-link", id: item.anchor },
             context.memberSignatureTitle(item),
             (0, anchor_icon_1.anchorIcon)(context, item.anchor)),

package/dist/lib/output/themes/default/partials/members.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 members(context: DefaultThemeRenderContext, props: ContainerReflection): JSX.Element;

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

@@ -2,9 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.members = void 0;
 const utils_1 = require("../../../../utils");
+const models_1 = require("../../../../models");
+const lib_1 = require("../../lib");
 function members(context, props) {
     if (props.categories && props.categories.length) {
-        return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, props.categories.map((item) => !item.allChildrenHaveOwnDocument() && (utils_1.JSX.createElement("section", { class: "tsd-panel-group tsd-member-group " + props.cssClasses },
+        return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, props.categories.map((item) => !item.allChildrenHaveOwnDocument() && (utils_1.JSX.createElement("section", { class: (0, lib_1.classNames)({ "tsd-panel-group": true, "tsd-member-group": true }, props instanceof models_1.DeclarationReflection ? context.getReflectionClasses(props) : "") },
             utils_1.JSX.createElement("h2", null, item.title),
             item.children.map((item) => !item.hasOwnDocument && context.member(item)))))));
     }

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

@@ -90,8 +90,8 @@ function primaryNavigation(context, props) {
         if (childModules?.length) {
             childNav = utils_1.JSX.createElement("ul", null, childModules.map(link));
         }
-        return (utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ current, selected, deprecated: mod.isDeprecated() }, mod.cssClasses) },
-            utils_1.JSX.createElement("a", { href: context.urlTo(mod) }, (0, lib_1.wbr)(`${mod.name}${mod.version !== undefined ? ` - v${mod.version}` : ""}`)),
+        return (utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ current, selected, deprecated: mod.isDeprecated() }, context.getReflectionClasses(mod)) },
+            utils_1.JSX.createElement("a", { href: context.urlTo(mod) }, (0, lib_1.wbr)((0, lib_1.getDisplayName)(context, mod))),
             childNav));
     }
 }
@@ -108,7 +108,7 @@ function secondaryNavigation(context, props) {
     const pageNavigation = children
         .filter((child) => !child.kindOf(models_1.ReflectionKind.SomeModule))
         .map((child) => {
-        return (utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ deprecated: child.isDeprecated(), current: props.model === child }, child.cssClasses) },
+        return (utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ deprecated: child.isDeprecated(), current: props.model === child }, context.getReflectionClasses(child)) },
             utils_1.JSX.createElement("a", { href: context.urlTo(child), class: "tsd-index-link" },
                 context.icons[child.kind](),
                 (0, lib_1.renderName)(child))));
@@ -121,7 +121,9 @@ function secondaryNavigation(context, props) {
             utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({
                     deprecated: effectivePageParent.isDeprecated(),
                     current: effectivePageParent === props.model,
-                }, effectivePageParent.cssClasses) },
+                }, effectivePageParent instanceof models_1.DeclarationReflection
+                    ? context.getReflectionClasses(effectivePageParent)
+                    : "") },
                 utils_1.JSX.createElement("a", { href: context.urlTo(effectivePageParent), class: "tsd-index-link" },
                     context.icons[effectivePageParent.kind](),
                     utils_1.JSX.createElement("span", null, (0, lib_1.renderName)(effectivePageParent))),

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

@@ -7,7 +7,7 @@ const models_1 = require("../../../../models");
 const parameter = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
     utils_1.JSX.createElement("ul", { class: "tsd-parameters" },
         !!props.signatures && (utils_1.JSX.createElement("li", { class: "tsd-parameter-signature" },
-            utils_1.JSX.createElement("ul", { class: "tsd-signatures " + props.cssClasses }, props.signatures.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+            utils_1.JSX.createElement("ul", { class: (0, lib_1.classNames)({ "tsd-signatures": true }, context.getReflectionClasses(props)) }, props.signatures.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                 utils_1.JSX.createElement("li", { class: "tsd-signature", id: item.anchor }, context.memberSignatureTitle(item, {
                     hideName: true,
                 })),

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

@@ -50,7 +50,7 @@ function getNamespacedPath(reflection) {
     return path;
 }
 function renderUniquePath(context, reflection) {
-    return (0, lib_1.join)(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "."), getUniquePath(reflection), (item) => (utils_1.JSX.createElement("a", { href: context.urlTo(item), class: "tsd-signature-type", "data-tsd-kind": item.kindString }, item.name)));
+    return (0, lib_1.join)(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "."), getUniquePath(reflection), (item) => (utils_1.JSX.createElement("a", { href: context.urlTo(item), class: "tsd-signature-type", "data-tsd-kind": models_1.ReflectionKind.singularString(item.kind) }, item.name)));
 }
 let indentationDepth = 0;
 function includeIndentation() {
@@ -148,7 +148,7 @@ const typeRenderers = {
             " ",
             utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "}")));
     },
-    "named-tuple-member"(context, type) {
+    namedTupleMember(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             type.name,
             type.isOptional ? (utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "?: ")) : (utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ": ")),
@@ -178,7 +178,7 @@ const typeRenderers = {
         if (reflection) {
             if (reflection.kindOf(models_1.ReflectionKind.TypeParameter)) {
                 // Don't generate a link will always point to this page, but do set the kind.
-                name = (utils_1.JSX.createElement("span", { class: "tsd-signature-type", "data-tsd-kind": reflection.kindString }, reflection.name));
+                name = (utils_1.JSX.createElement("span", { class: "tsd-signature-type", "data-tsd-kind": models_1.ReflectionKind.singularString(reflection.kind) }, reflection.name));
             }
             else {
                 name = renderUniquePath(context, reflection);
@@ -299,7 +299,7 @@ const typeRenderers = {
             utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
             renderType(context, type.elementType, models_1.TypeContext.restElement)));
     },
-    "template-literal"(context, type) {
+    templateLiteral(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "`"),
             type.head && utils_1.JSX.createElement("span", { class: "tsd-signature-type" }, type.head),

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

@@ -23,7 +23,7 @@ function reflectionTemplate(context, props) {
                 utils_1.JSX.createElement("h4", null, "Implemented by"),
                 utils_1.JSX.createElement("ul", { class: "tsd-hierarchy" }, props.model.implementedBy.map((item) => (utils_1.JSX.createElement("li", null, context.type(item))))))),
             !!props.model.signatures && (utils_1.JSX.createElement("section", { class: "tsd-panel" }, context.memberSignatures(props.model))),
-            !!props.model.indexSignature && (utils_1.JSX.createElement("section", { class: "tsd-panel " + props.model.cssClasses },
+            !!props.model.indexSignature && (utils_1.JSX.createElement("section", { class: (0, lib_1.classNames)({ "tsd-panel": true }, context.getReflectionClasses(props.model)) },
                 utils_1.JSX.createElement("h4", { class: "tsd-before-signature" }, "Indexable"),
                 utils_1.JSX.createElement("div", { class: "tsd-signature" },
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "["),

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

@@ -1,6 +1,8 @@
-import { Comment, Reflection, ReflectionFlags, TypeParameterReflection } from "../../models";
+import { Comment, CommentDisplayPart, Reflection, ReflectionFlags, TypeParameterReflection } from "../../models";
 import { JSX } from "../../utils";
+import type { DefaultThemeRenderContext } from "./default/DefaultThemeRenderContext";
 export declare function stringify(data: unknown): string;
+export declare function getDisplayName(context: DefaultThemeRenderContext, refl: Reflection): string;
 /**
  * Insert word break tags ``<wbr>`` into the given string.
  *
@@ -18,6 +20,7 @@ export declare function hasTypeParameters(reflection: Reflection): reflection is
 };
 export declare function renderTypeParametersSignature(typeParameters: readonly TypeParameterReflection[] | undefined): JSX.Element;
 export declare function camelToTitleCase(text: string): string;
+export declare function displayPartsToMarkdown(parts: readonly CommentDisplayPart[], urlTo: DefaultThemeRenderContext["urlTo"]): string;
 /**
  * Renders the reflection name with an additional `?` if optional.
  */

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.renderFlags = exports.join = exports.wbr = exports.stringify = void 0;
+exports.renderName = exports.displayPartsToMarkdown = exports.camelToTitleCase = exports.renderTypeParametersSignature = exports.hasTypeParameters = exports.classNames = exports.renderFlags = exports.join = exports.wbr = exports.getDisplayName = exports.stringify = void 0;
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 function stringify(data) {
@@ -10,6 +10,16 @@ function stringify(data) {
     return JSON.stringify(data);
 }
 exports.stringify = stringify;
+function getDisplayName(context, refl) {
+    let version = "";
+    if ((refl instanceof models_1.DeclarationReflection || refl instanceof models_1.ProjectReflection) &&
+        refl.packageVersion &&
+        context.options.getValue("includeVersion")) {
+        version = ` - v${refl.packageVersion}`;
+    }
+    return `${refl.name}${version}`;
+}
+exports.getDisplayName = getDisplayName;
 /**
  * Insert word break tags ``<wbr>`` into the given string.
  *
@@ -74,7 +84,7 @@ function renderTypeParametersSignature(typeParameters) {
         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "<"),
         join(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ", "), typeParameters, (item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             item.varianceModifier ? `${item.varianceModifier} ` : "",
-            utils_1.JSX.createElement("span", { class: "tsd-signature-type", "data-tsd-kind": item.kindString }, item.name)))),
+            utils_1.JSX.createElement("span", { class: "tsd-signature-type", "data-tsd-kind": models_1.ReflectionKind.singularString(item.kind) }, item.name)))),
         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ">")))));
 }
 exports.renderTypeParametersSignature = renderTypeParametersSignature;
@@ -82,12 +92,52 @@ function camelToTitleCase(text) {
     return text.substring(0, 1).toUpperCase() + text.substring(1).replace(/[a-z][A-Z]/g, (x) => `${x[0]} ${x[1]}`);
 }
 exports.camelToTitleCase = camelToTitleCase;
+function displayPartsToMarkdown(parts, urlTo) {
+    const result = [];
+    for (const part of parts) {
+        switch (part.kind) {
+            case "text":
+            case "code":
+                result.push(part.text);
+                break;
+            case "inline-tag":
+                switch (part.tag) {
+                    case "@label":
+                    case "@inheritdoc": // Shouldn't happen
+                        break; // Not rendered.
+                    case "@link":
+                    case "@linkcode":
+                    case "@linkplain": {
+                        if (part.target) {
+                            const url = typeof part.target === "string" ? part.target : urlTo(part.target);
+                            const text = part.tag === "@linkcode" ? `<code>${part.text}</code>` : part.text;
+                            result.push(url ? `<a href="${url}">${text}</a>` : part.text);
+                        }
+                        else {
+                            result.push(part.text);
+                        }
+                        break;
+                    }
+                    default:
+                        // Hmm... probably want to be able to render these somehow, so custom inline tags can be given
+                        // special rendering rules. Future capability. For now, just render their text.
+                        result.push(`{${part.tag} ${part.text}}`);
+                        break;
+                }
+                break;
+            default:
+                (0, utils_1.assertNever)(part);
+        }
+    }
+    return result.join("");
+}
+exports.displayPartsToMarkdown = displayPartsToMarkdown;
 /**
  * Renders the reflection name with an additional `?` if optional.
  */
 function renderName(refl) {
     if (!refl.name) {
-        return utils_1.JSX.createElement("em", null, wbr(refl.kindString));
+        return utils_1.JSX.createElement("em", null, wbr(models_1.ReflectionKind.singularString(refl.kind)));
     }
     if (refl.flags.isOptional) {
         return utils_1.JSX.createElement(utils_1.JSX.Fragment, null,

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

@@ -0,0 +1,54 @@
+import type { Application } from "../application";
+import { ProjectReflection, ReflectionVariant, TypeKindMap } from "../models/index";
+import type { Logger } from "../utils/loggers";
+import type { JSONOutput } from "./index";
+export interface DeserializerComponent {
+    priority: number;
+    supports(model: unknown, obj: unknown): boolean;
+    fromObject(model: unknown, obj: unknown): void;
+}
+export interface Deserializable<T> {
+    fromObject(d: Deserializer, o: T): void;
+}
+export declare class Deserializer {
+    private app;
+    private deferred;
+    private deserializers;
+    private activeReflection;
+    constructor(app: Application);
+    get logger(): Logger;
+    reflectionBuilders: {
+        [K in keyof ReflectionVariant]: (parent: NonNullable<ReflectionVariant[K]["parent"]>, obj: JSONOutput.ModelToObject<ReflectionVariant[K]>) => ReflectionVariant[K];
+    };
+    typeBuilders: {
+        [K in keyof TypeKindMap]: (obj: JSONOutput.ModelToObject<TypeKindMap[K]>, de: Deserializer) => TypeKindMap[K];
+    };
+    oldIdToNewId: Record<number, number | undefined>;
+    project: ProjectReflection | undefined;
+    addDeserializer(de: DeserializerComponent): void;
+    /**
+     * Revive a single project into the structure it was originally created with.
+     * This is generally not appropriate for merging multiple projects since projects may
+     * contain reflections in their root, not inside a module.
+     */
+    reviveProject(projectObj: JSONOutput.ProjectReflection, name?: string): ProjectReflection;
+    reviveProjects(name: string, projects: readonly JSONOutput.ProjectReflection[]): ProjectReflection;
+    revive<T, U extends Deserializable<T>>(source: NonNullable<T>, creator: (obj: T) => U): U;
+    revive<T, U extends Deserializable<T>>(source: T | undefined, creator: (obj: T) => U): U | undefined;
+    reviveMany<T, U extends Deserializable<T>>(sourceArray: T[], creator: (obj: T) => U): U[];
+    reviveMany<T, U extends Deserializable<T>>(sourceArray: T[] | undefined, creator: (obj: T) => U): U[] | undefined;
+    reviveType<T extends JSONOutput.SomeType>(obj: T): TypeKindMap[T["type"]];
+    reviveType<T extends JSONOutput.SomeType>(obj: T | undefined): TypeKindMap[T["type"]] | undefined;
+    constructReflection<T extends JSONOutput.SomeReflection>(obj: T): ReflectionVariant[T["variant"]];
+    constructType<T extends JSONOutput.SomeType>(obj: T): TypeKindMap[T["type"]];
+    fromObject<T>(receiver: {
+        fromObject(d: Deserializer, o: T): void;
+    }, obj: T): void;
+    /**
+     * Defers work until the initial pass of serialization has been completed.
+     * This can be used to set up references which cannot be immediately restored.
+     *
+     * May only be called when deserializing.
+     */
+    defer(cb: (project: ProjectReflection) => void): void;
+}