typedoc 0.26.10 → 0.27.0-beta.0

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

@@ -1,9 +1,9 @@
-import type { PageEvent, Renderer } from "../..";
-import type { Internationalization, TranslationProxy } from "../../../internationalization/internationalization";
-import type { DocumentReflection, CommentDisplayPart, DeclarationReflection, Reflection } from "../../../models";
-import { type NeverIfInternal, type Options } from "../../../utils";
-import type { DefaultTheme } from "./DefaultTheme";
-import { type icons } from "./partials/icon";
+import type { PageEvent, Renderer } from "../../index.js";
+import type { Internationalization, TranslationProxy } from "../../../internationalization/internationalization.js";
+import type { DocumentReflection, CommentDisplayPart, DeclarationReflection, Reflection } from "../../../models/index.js";
+import { type NeverIfInternal, type Options } from "../../../utils/index.js";
+import type { DefaultTheme } from "./DefaultTheme.js";
+import { type icons } from "./partials/icon.js";
 export declare class DefaultThemeRenderContext {
     readonly theme: DefaultTheme;
     page: PageEvent<Reflection>;
@@ -19,18 +19,21 @@ export declare class DefaultThemeRenderContext {
      * to customize icons, that object must be modified instead.
      */
     get icons(): Readonly<typeof icons>;
+    get slugger(): import("./Slugger.js").Slugger;
     hook: Renderer["hooks"]["emit"];
     /** Avoid this in favor of urlTo if possible */
     relativeURL: (url: string, cacheBust?: boolean) => string;
     urlTo: (reflection: Reflection) => string;
     markdown: (md: readonly CommentDisplayPart[] | NeverIfInternal<string | undefined>) => string;
-    getNavigation: () => import("./DefaultTheme").NavigationElement[];
+    /** Renders user comment markdown wrapped in a tsd-comment div */
+    displayParts: (parts: readonly CommentDisplayPart[] | undefined) => import("../../../utils/jsx.elements.js").JsxElement | undefined;
+    getNavigation: () => import("./DefaultTheme.js").NavigationElement[];
     getReflectionClasses: (refl: DeclarationReflection | DocumentReflection) => string;
-    documentTemplate: (props: PageEvent<DocumentReflection>) => import("../../../utils/jsx.elements").JsxElement;
-    reflectionTemplate: (props: PageEvent<import("../../../models").ContainerReflection>) => import("../../../utils/jsx.elements").JsxElement;
-    indexTemplate: (props: PageEvent<import("../../../models").ProjectReflection>) => import("../../../utils/jsx.elements").JsxElement;
-    hierarchyTemplate: (props: PageEvent<import("../../../models").ProjectReflection>) => import("../../../utils/jsx.elements").JsxElement;
-    defaultLayout: (template: import("../..").RenderTemplate<PageEvent<Reflection>>, props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
+    documentTemplate: (props: PageEvent<DocumentReflection>) => import("../../../utils/jsx.elements.js").JsxElement;
+    reflectionTemplate: (props: PageEvent<import("../../../models/index.js").ContainerReflection>) => import("../../../utils/jsx.elements.js").JsxElement;
+    indexTemplate: (props: PageEvent<import("../../../models/index.js").ProjectReflection>) => import("../../../utils/jsx.elements.js").JsxElement;
+    hierarchyTemplate: (props: PageEvent<import("../../../models/index.js").ProjectReflection>) => import("../../../utils/jsx.elements.js").JsxElement;
+    defaultLayout: (template: import("../../index.js").RenderTemplate<PageEvent<Reflection>>, props: PageEvent<Reflection>) => import("../../../utils/jsx.elements.js").JsxElement;
     /**
      * Rendered just after the description for a reflection.
      * This can be used to render a shortened type display of a reflection that the
@@ -39,43 +42,55 @@ export declare class DefaultThemeRenderContext {
      * Note: Will not be called for variables/type aliases, as they are summarized
      * by their type declaration, which is already rendered by {@link DefaultThemeRenderContext.memberDeclaration}
      */
-    reflectionPreview: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
-    breadcrumb: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
-    commentSummary: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
-    commentTags: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
-    reflectionFlags: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement;
-    footer: () => import("../../../utils/jsx.elements").JsxElement;
-    header: (props: 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: DeclarationReflection | DocumentReflection) => 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: (props: import("../../../models").SignatureReflection, r_1?: {
+    reflectionPreview: (props: Reflection) => import("../../../utils/jsx.elements.js").JsxElement | undefined;
+    /**
+     * Used to render additional details about a type. This is used to implement
+     * the `@expand` tag, comments on union members, comments on object type members...
+     */
+    typeDetails: (type: import("../../../models/types.js").SomeType, renderAnchors: boolean) => import("../../../utils/jsx.elements.js").JsxChildren;
+    /**
+     * Should call the {@link typeDetails} helper if rendering additional details
+     * about the type will provide the user with more information about the type.
+     */
+    typeDetailsIfUseful: (type: import("../../../models/types.js").SomeType | undefined) => import("../../../utils/jsx.elements.js").JsxChildren;
+    /**
+     * Wrapper around {@link typeDetails} which checks if it is useful
+     * and includes a "Type Declaration" header.
+     */
+    typeDeclaration: (type: import("../../../models/types.js").SomeType) => import("../../../utils/jsx.elements.js").JsxChildren;
+    breadcrumb: (props: Reflection) => import("../../../utils/jsx.elements.js").JsxElement | undefined;
+    commentShortSummary: (props: Reflection) => import("../../../utils/jsx.elements.js").JsxElement | undefined;
+    commentSummary: (props: Reflection) => import("../../../utils/jsx.elements.js").JsxElement | undefined;
+    commentTags: (props: Reflection) => import("../../../utils/jsx.elements.js").JsxElement | undefined;
+    reflectionFlags: (props: Reflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    footer: () => import("../../../utils/jsx.elements.js").JsxElement;
+    header: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements.js").JsxElement;
+    hierarchy: (props: import("../../../models/index.js").DeclarationHierarchy | undefined) => import("../../../utils/jsx.elements.js").JsxElement | undefined;
+    index: (props: import("../../../models/index.js").ContainerReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    member: (props: DeclarationReflection | DocumentReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    moduleReflection: (mod: DeclarationReflection | import("../../../models/index.js").ProjectReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    moduleMemberSummary: (member: DeclarationReflection | DocumentReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    memberDeclaration: (props: DeclarationReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    memberGetterSetter: (props: DeclarationReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    memberSignatureBody: (props: import("../../../models/index.js").SignatureReflection, r_1?: {
         hideSources?: boolean;
-    } | undefined) => import("../../../utils/jsx.elements").JsxElement;
-    memberSignatureTitle: (props: import("../../../models").SignatureReflection, r_1?: {
+    } | undefined) => import("../../../utils/jsx.elements.js").JsxElement;
+    memberSignatureTitle: (props: import("../../../models/index.js").SignatureReflection, options?: {
         hideName?: boolean;
-        arrowStyle?: boolean;
-        hideParamTypes?: boolean;
-    } | undefined) => import("../../../utils/jsx.elements").JsxElement;
-    memberSignatures: (props: DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
-    memberSources: (props: DeclarationReflection | import("../../../models").SignatureReflection) => import("../../../utils/jsx.elements").JsxElement;
-    members: (props: import("../../../models").ContainerReflection) => import("../../../utils/jsx.elements").JsxElement;
-    /** @deprecated Since 0.26.3 members does group/category flattening internally */
-    membersGroup?: Function;
-    sidebar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
-    pageSidebar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
-    sidebarLinks: () => import("../../../utils/jsx.elements").JsxElement | null;
-    settings: () => import("../../../utils/jsx.elements").JsxElement;
-    navigation: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
-    pageNavigation: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
-    parameter: (props: DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
-    toolbar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
-    type: (type: import("../../../models").Type | undefined, options?: {
+    } | undefined) => import("../../../utils/jsx.elements.js").JsxElement;
+    memberSignatures: (props: DeclarationReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    memberSources: (props: DeclarationReflection | import("../../../models/index.js").SignatureReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    members: (props: import("../../../models/index.js").ContainerReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    sidebar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements.js").JsxElement;
+    pageSidebar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements.js").JsxElement;
+    sidebarLinks: () => import("../../../utils/jsx.elements.js").JsxElement | null;
+    settings: () => import("../../../utils/jsx.elements.js").JsxElement;
+    navigation: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements.js").JsxElement;
+    pageNavigation: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements.js").JsxElement;
+    toolbar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements.js").JsxElement;
+    type: (type: import("../../../models/types.js").SomeType | undefined, options?: {
         topLevelLinks: boolean;
-    } | undefined) => import("../../../utils/jsx.elements").JsxElement;
-    typeAndParent: (props: import("../../../models").Type) => import("../../../utils/jsx.elements").JsxElement;
-    typeParameters: (typeParameters: import("../../../models").TypeParameterReflection[]) => import("../../../utils/jsx.elements").JsxElement;
+    } | undefined) => import("../../../utils/jsx.elements.js").JsxElement;
+    typeAndParent: (props: import("../../../models/types.js").Type) => import("../../../utils/jsx.elements.js").JsxElement;
+    typeParameters: (typeParameters: import("../../../models/index.js").TypeParameterReflection[]) => import("../../../utils/jsx.elements.js").JsxElement;
 }

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

@@ -1,106 +1,49 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultThemeRenderContext = void 0;
-const default_1 = require("./layouts/default");
-const partials_1 = require("./partials");
-const breadcrumb_1 = require("./partials/breadcrumb");
-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");
-const member_reference_1 = require("./partials/member.reference");
-const member_signature_body_1 = require("./partials/member.signature.body");
-const member_signature_title_1 = require("./partials/member.signature.title");
-const member_signatures_1 = require("./partials/member.signatures");
-const member_sources_1 = require("./partials/member.sources");
-const members_1 = require("./partials/members");
-const navigation_1 = require("./partials/navigation");
-const parameter_1 = require("./partials/parameter");
-const reflectionPreview_1 = require("./partials/reflectionPreview");
-const toolbar_1 = require("./partials/toolbar");
-const type_1 = require("./partials/type");
-const typeAndParent_1 = require("./partials/typeAndParent");
-const typeParameters_1 = require("./partials/typeParameters");
-const templates_1 = require("./templates");
-const document_1 = require("./templates/document");
-const hierarchy_2 = require("./templates/hierarchy");
-const reflection_1 = require("./templates/reflection");
+import {} from "../../../utils/index.js";
+import { defaultLayout } from "./layouts/default.js";
+import { index } from "./partials/index.js";
+import { breadcrumb } from "./partials/breadcrumb.js";
+import { commentShortSummary, commentSummary, commentTags, reflectionFlags, renderDisplayParts, } from "./partials/comment.js";
+import { footer } from "./partials/footer.js";
+import { header } from "./partials/header.js";
+import { hierarchy } from "./partials/hierarchy.js";
+import { buildRefIcons } from "./partials/icon.js";
+import { member } from "./partials/member.js";
+import { memberDeclaration } from "./partials/member.declaration.js";
+import { memberGetterSetter } from "./partials/member.getterSetter.js";
+import { memberSignatureBody } from "./partials/member.signature.body.js";
+import { memberSignatureTitle } from "./partials/member.signature.title.js";
+import { memberSignatures } from "./partials/member.signatures.js";
+import { memberSources } from "./partials/member.sources.js";
+import { members } from "./partials/members.js";
+import { sidebar, pageSidebar, navigation, pageNavigation, settings, sidebarLinks, } from "./partials/navigation.js";
+import { reflectionPreview } from "./partials/reflectionPreview.js";
+import { toolbar } from "./partials/toolbar.js";
+import { type } from "./partials/type.js";
+import { typeAndParent } from "./partials/typeAndParent.js";
+import { typeParameters } from "./partials/typeParameters.js";
+import { indexTemplate } from "./templates/index.js";
+import { documentTemplate } from "./templates/document.js";
+import { hierarchyTemplate } from "./templates/hierarchy.js";
+import { reflectionTemplate } from "./templates/reflection.js";
+import { typeDeclaration, typeDetails, typeDetailsIfUseful, } from "./partials/typeDetails.js";
+import { moduleMemberSummary, moduleReflection, } from "./partials/moduleReflection.js";
 function bind(fn, first) {
     return (...r) => fn(first, ...r);
 }
-class DefaultThemeRenderContext {
+export class DefaultThemeRenderContext {
+    theme;
+    page;
+    _refIcons;
+    options;
+    internationalization;
+    i18n;
     constructor(theme, page, options) {
         this.theme = theme;
         this.page = page;
-        this.hook = (...params) => {
-            return this.theme.owner.hooks.emit(...params);
-        };
-        /** Avoid this in favor of urlTo if possible */
-        this.relativeURL = (url, cacheBust = false) => {
-            const result = this.theme.markedPlugin.getRelativeUrl(url);
-            if (cacheBust && this.theme.owner.cacheBust) {
-                return result + `?cache=${this.theme.owner.renderStartTime}`;
-            }
-            return result;
-        };
-        this.urlTo = (reflection) => {
-            return reflection.url ? this.relativeURL(reflection.url) : "";
-        };
-        this.markdown = (md) => {
-            return this.theme.markedPlugin.parseMarkdown(md || "", this.page, this);
-        };
-        this.getNavigation = () => this.theme.getNavigation(this.page.project);
-        this.getReflectionClasses = (refl) => this.theme.getReflectionClasses(refl);
-        this.documentTemplate = bind(document_1.documentTemplate, this);
-        this.reflectionTemplate = bind(reflection_1.reflectionTemplate, this);
-        this.indexTemplate = bind(templates_1.indexTemplate, this);
-        this.hierarchyTemplate = bind(hierarchy_2.hierarchyTemplate, this);
-        this.defaultLayout = bind(default_1.defaultLayout, this);
-        /**
-         * Rendered just after the description for a reflection.
-         * This can be used to render a shortened type display of a reflection that the
-         * rest of the page expands on.
-         *
-         * Note: Will not be called for variables/type aliases, as they are summarized
-         * by their type declaration, which is already rendered by {@link DefaultThemeRenderContext.memberDeclaration}
-         */
-        this.reflectionPreview = bind(reflectionPreview_1.reflectionPreview, this);
-        this.breadcrumb = bind(breadcrumb_1.breadcrumb, this);
-        this.commentSummary = bind(comment_1.commentSummary, this);
-        this.commentTags = bind(comment_1.commentTags, this);
-        this.reflectionFlags = bind(comment_1.reflectionFlags, this);
-        this.footer = bind(footer_1.footer, this);
-        this.header = bind(header_1.header, this);
-        this.hierarchy = bind(hierarchy_1.hierarchy, this);
-        this.index = bind(partials_1.index, this);
-        this.member = bind(member_1.member, this);
-        this.memberDeclaration = bind(member_declaration_1.memberDeclaration, this);
-        this.memberGetterSetter = bind(member_getterSetter_1.memberGetterSetter, this);
-        this.memberReference = bind(member_reference_1.memberReference, this);
-        this.memberSignatureBody = bind(member_signature_body_1.memberSignatureBody, this);
-        this.memberSignatureTitle = bind(member_signature_title_1.memberSignatureTitle, this);
-        this.memberSignatures = bind(member_signatures_1.memberSignatures, this);
-        this.memberSources = bind(member_sources_1.memberSources, this);
-        this.members = bind(members_1.members, this);
-        this.sidebar = bind(navigation_1.sidebar, this);
-        this.pageSidebar = bind(navigation_1.pageSidebar, this);
-        this.sidebarLinks = bind(navigation_1.sidebarLinks, this);
-        this.settings = bind(navigation_1.settings, this);
-        this.navigation = bind(navigation_1.navigation, this);
-        this.pageNavigation = bind(navigation_1.pageNavigation, this);
-        this.parameter = bind(parameter_1.parameter, this);
-        this.toolbar = bind(toolbar_1.toolbar, this);
-        this.type = bind(type_1.type, this);
-        this.typeAndParent = bind(typeAndParent_1.typeAndParent, this);
-        this.typeParameters = bind(typeParameters_1.typeParameters, this);
         this.options = options;
         this.internationalization = theme.application.internationalization;
         this.i18n = this.internationalization.proxy;
-        this._refIcons = (0, icon_1.buildRefIcons)(theme.icons, this);
+        this._refIcons = buildRefIcons(theme.icons, this);
     }
     /**
      * Icons available for use within the page.
@@ -111,5 +54,86 @@ class DefaultThemeRenderContext {
     get icons() {
         return this._refIcons;
     }
+    get slugger() {
+        return this.theme.getSlugger(this.page.model);
+    }
+    hook = (...params) => {
+        return this.theme.owner.hooks.emit(...params);
+    };
+    /** Avoid this in favor of urlTo if possible */
+    relativeURL = (url, cacheBust = false) => {
+        const result = this.theme.markedPlugin.getRelativeUrl(url);
+        if (cacheBust && this.theme.owner.cacheBust) {
+            return result + `?cache=${this.theme.owner.renderStartTime}`;
+        }
+        return result;
+    };
+    urlTo = (reflection) => {
+        return reflection.url ? this.relativeURL(reflection.url) : "";
+    };
+    markdown = (md) => {
+        return this.theme.markedPlugin.parseMarkdown(md || "", this.page, this);
+    };
+    /** Renders user comment markdown wrapped in a tsd-comment div */
+    displayParts = bind(renderDisplayParts, this);
+    getNavigation = () => this.theme.getNavigation(this.page.project);
+    getReflectionClasses = (refl) => this.theme.getReflectionClasses(refl);
+    documentTemplate = bind(documentTemplate, this);
+    reflectionTemplate = bind(reflectionTemplate, this);
+    indexTemplate = bind(indexTemplate, this);
+    hierarchyTemplate = bind(hierarchyTemplate, this);
+    defaultLayout = bind(defaultLayout, this);
+    /**
+     * Rendered just after the description for a reflection.
+     * This can be used to render a shortened type display of a reflection that the
+     * rest of the page expands on.
+     *
+     * Note: Will not be called for variables/type aliases, as they are summarized
+     * by their type declaration, which is already rendered by {@link DefaultThemeRenderContext.memberDeclaration}
+     */
+    reflectionPreview = bind(reflectionPreview, this);
+    /**
+     * Used to render additional details about a type. This is used to implement
+     * the `@expand` tag, comments on union members, comments on object type members...
+     */
+    typeDetails = bind(typeDetails, this);
+    /**
+     * Should call the {@link typeDetails} helper if rendering additional details
+     * about the type will provide the user with more information about the type.
+     */
+    typeDetailsIfUseful = bind(typeDetailsIfUseful, this);
+    /**
+     * Wrapper around {@link typeDetails} which checks if it is useful
+     * and includes a "Type Declaration" header.
+     */
+    typeDeclaration = bind(typeDeclaration, this);
+    breadcrumb = bind(breadcrumb, this);
+    commentShortSummary = bind(commentShortSummary, this);
+    commentSummary = bind(commentSummary, this);
+    commentTags = bind(commentTags, this);
+    reflectionFlags = bind(reflectionFlags, this);
+    footer = bind(footer, this);
+    header = bind(header, this);
+    hierarchy = bind(hierarchy, this);
+    index = bind(index, this);
+    member = bind(member, this);
+    moduleReflection = bind(moduleReflection, this);
+    moduleMemberSummary = bind(moduleMemberSummary, this);
+    memberDeclaration = bind(memberDeclaration, this);
+    memberGetterSetter = bind(memberGetterSetter, this);
+    memberSignatureBody = bind(memberSignatureBody, this);
+    memberSignatureTitle = bind(memberSignatureTitle, this);
+    memberSignatures = bind(memberSignatures, this);
+    memberSources = bind(memberSources, this);
+    members = bind(members, this);
+    sidebar = bind(sidebar, this);
+    pageSidebar = bind(pageSidebar, this);
+    sidebarLinks = bind(sidebarLinks, this);
+    settings = bind(settings, this);
+    navigation = bind(navigation, this);
+    pageNavigation = bind(pageNavigation, this);
+    toolbar = bind(toolbar, this);
+    type = bind(type, this);
+    typeAndParent = bind(typeAndParent, this);
+    typeParameters = bind(typeParameters, this);
 }
-exports.DefaultThemeRenderContext = DefaultThemeRenderContext;

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

@@ -0,0 +1,13 @@
+import type { TypeDocOptionMap } from "../../../utils/index.js";
+/**
+ * Responsible for getting a unique anchor for elements within a page.
+ */
+export declare class Slugger {
+    private options;
+    private seen;
+    private serialize;
+    constructor(options: TypeDocOptionMap["sluggerConfiguration"]);
+    slug(value: string): string;
+    hasAnchor(anchor: string): boolean;
+    getSimilarAnchors(anchor: string): string[];
+}

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

@@ -0,0 +1,46 @@
+import { getSimilarValues } from "../../../utils/general.js";
+/**
+ * Responsible for getting a unique anchor for elements within a page.
+ */
+export class Slugger {
+    options;
+    seen = new Map();
+    serialize(value) {
+        // Notes:
+        // There are quite a few trade-offs here.
+        return (value
+            .trim()
+            // remove html tags
+            .replace(/<[!/a-z].*?>/gi, "")
+            // remove unwanted chars
+            .replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,./:;<=>?@[\]^`{|}~]/g, "")
+            .replace(/\s/g, "-"));
+    }
+    constructor(options) {
+        this.options = options;
+    }
+    slug(value) {
+        const originalSlug = this.serialize(value);
+        const lowerOriginalSlug = originalSlug.toLocaleLowerCase();
+        let count = 0;
+        let slug = lowerOriginalSlug;
+        if (this.seen.has(lowerOriginalSlug)) {
+            count = this.seen.get(lowerOriginalSlug);
+            do {
+                count++;
+                slug = `${lowerOriginalSlug}-${count}`;
+            } while (this.seen.has(slug));
+        }
+        this.seen.set(lowerOriginalSlug, count);
+        if (!this.options.lowercase) {
+            return count === 0 ? originalSlug : `${originalSlug}-${count}`;
+        }
+        return slug;
+    }
+    hasAnchor(anchor) {
+        return this.seen.has(anchor);
+    }
+    getSimilarAnchors(anchor) {
+        return getSimilarValues(this.seen.keys(), anchor);
+    }
+}

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

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

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

@@ -1,50 +1,83 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultLayout = void 0;
-const utils_1 = require("../../../../utils");
-const lib_1 = require("../../lib");
-const defaultLayout = (context, template, props) => (utils_1.JSX.createElement("html", { class: "default", lang: context.options.getValue("lang") },
-    utils_1.JSX.createElement("head", null,
-        utils_1.JSX.createElement("meta", { charset: "utf-8" }),
+import { JSX, Raw } from "../../../../utils/index.js";
+import { getDisplayName } from "../../lib.js";
+import { extname } from "path";
+function favicon(context) {
+    const fav = context.options.getValue("favicon");
+    if (!fav)
+        return null;
+    switch (extname(fav)) {
+        case ".ico":
+            return JSX.createElement("link", { rel: "icon", href: context.relativeURL("assets/favicon.ico", true) });
+        case ".svg":
+            return JSX.createElement("link", { rel: "icon", href: context.relativeURL("assets/favicon.svg", true), type: "image/svg+xml" });
+        default:
+            return null;
+    }
+}
+// See #2760
+function buildSiteMetadata(context) {
+    try {
+        // We have to know where we are hosted in order to generate this block
+        const url = new URL(context.options.getValue("hostedBaseUrl"));
+        // No point in generating this if we aren't the root page on the site
+        if (url.pathname !== "/") {
+            return null;
+        }
+        return (JSX.createElement("script", { type: "application/ld+json" },
+            JSX.createElement(Raw, { html: JSON.stringify({
+                    "@context": "https://schema.org",
+                    "@type": "WebSite",
+                    name: context.page.project.name,
+                    url: url.toString(),
+                }) })));
+    }
+    catch {
+        return null;
+    }
+}
+export const defaultLayout = (context, template, props) => (JSX.createElement("html", { class: "default", lang: context.options.getValue("lang") },
+    JSX.createElement("head", null,
+        JSX.createElement("meta", { charset: "utf-8" }),
         context.hook("head.begin", context),
-        utils_1.JSX.createElement("meta", { "http-equiv": "x-ua-compatible", content: "IE=edge" }),
-        utils_1.JSX.createElement("title", null, props.model.isProject()
-            ? (0, lib_1.getDisplayName)(props.model)
-            : `${(0, lib_1.getDisplayName)(props.model)} | ${(0, lib_1.getDisplayName)(props.project)}`),
-        utils_1.JSX.createElement("meta", { name: "description", content: "Documentation for " + props.project.name }),
-        utils_1.JSX.createElement("meta", { name: "viewport", content: "width=device-width, initial-scale=1" }),
-        utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/style.css", true) }),
-        utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/highlight.css", true) }),
-        context.options.getValue("customCss") && (utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/custom.css", true) })),
-        utils_1.JSX.createElement("script", { defer: true, src: context.relativeURL("assets/main.js", true) }),
-        context.options.getValue("customJs") && (utils_1.JSX.createElement("script", { defer: true, src: context.relativeURL("assets/custom.js", true) })),
-        utils_1.JSX.createElement("script", { async: true, src: context.relativeURL("assets/icons.js", true), id: "tsd-icons-script" }),
-        utils_1.JSX.createElement("script", { async: true, src: context.relativeURL("assets/search.js", true), id: "tsd-search-script" }),
-        utils_1.JSX.createElement("script", { async: true, src: context.relativeURL("assets/navigation.js", true), id: "tsd-nav-script" }),
+        JSX.createElement("meta", { "http-equiv": "x-ua-compatible", content: "IE=edge" }),
+        JSX.createElement("title", null, props.model.isProject()
+            ? getDisplayName(props.model)
+            : `${getDisplayName(props.model)} | ${getDisplayName(props.project)}`),
+        favicon(context),
+        props.url === "index.html" && buildSiteMetadata(context),
+        JSX.createElement("meta", { name: "description", content: "Documentation for " + props.project.name }),
+        JSX.createElement("meta", { name: "viewport", content: "width=device-width, initial-scale=1" }),
+        JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/style.css", true) }),
+        JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/highlight.css", true) }),
+        context.options.getValue("customCss") && (JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/custom.css", true) })),
+        JSX.createElement("script", { defer: true, src: context.relativeURL("assets/main.js", true) }),
+        context.options.getValue("customJs") && (JSX.createElement("script", { defer: true, src: context.relativeURL("assets/custom.js", true) })),
+        JSX.createElement("script", { async: true, src: context.relativeURL("assets/icons.js", true), id: "tsd-icons-script" }),
+        JSX.createElement("script", { async: true, src: context.relativeURL("assets/search.js", true), id: "tsd-search-script" }),
+        JSX.createElement("script", { async: true, src: context.relativeURL("assets/navigation.js", true), id: "tsd-nav-script" }),
         context.hook("head.end", context)),
-    utils_1.JSX.createElement("body", null,
+    JSX.createElement("body", null,
         context.hook("body.begin", context),
-        utils_1.JSX.createElement("script", null,
-            utils_1.JSX.createElement(utils_1.Raw, { html: 'document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";' }),
-            utils_1.JSX.createElement(utils_1.Raw, { html: 'document.body.style.display="none";' }),
-            utils_1.JSX.createElement(utils_1.Raw, { html: 'setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)' })),
+        JSX.createElement("script", null,
+            JSX.createElement(Raw, { html: 'document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";' }),
+            JSX.createElement(Raw, { html: 'document.body.style.display="none";' }),
+            JSX.createElement(Raw, { html: 'setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)' })),
         context.toolbar(props),
-        utils_1.JSX.createElement("div", { class: "container container-main" },
-            utils_1.JSX.createElement("div", { class: "col-content" },
+        JSX.createElement("div", { class: "container container-main" },
+            JSX.createElement("div", { class: "col-content" },
                 context.hook("content.begin", context),
                 context.header(props),
                 template(props),
                 context.hook("content.end", context)),
-            utils_1.JSX.createElement("div", { class: "col-sidebar" },
-                utils_1.JSX.createElement("div", { class: "page-menu" },
+            JSX.createElement("div", { class: "col-sidebar" },
+                JSX.createElement("div", { class: "page-menu" },
                     context.hook("pageSidebar.begin", context),
                     context.pageSidebar(props),
                     context.hook("pageSidebar.end", context)),
-                utils_1.JSX.createElement("div", { class: "site-menu" },
+                JSX.createElement("div", { class: "site-menu" },
                     context.hook("sidebar.begin", context),
                     context.sidebar(props),
                     context.hook("sidebar.end", context)))),
         context.footer(),
-        utils_1.JSX.createElement("div", { class: "overlay" }),
+        JSX.createElement("div", { class: "overlay" }),
         context.hook("body.end", context))));
-exports.defaultLayout = defaultLayout;

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

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

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

@@ -1,9 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.anchorIcon = anchorIcon;
-const utils_1 = require("../../../../utils");
-function anchorIcon(context, anchor) {
+import { JSX } from "../../../../utils/index.js";
+export function anchorIcon(context, anchor) {
     if (!anchor)
-        return utils_1.JSX.createElement(utils_1.JSX.Fragment, null);
-    return (utils_1.JSX.createElement("a", { href: `#${anchor}`, "aria-label": context.i18n.theme_permalink(), class: "tsd-anchor-icon" }, context.icons.anchor()));
+        return JSX.createElement(JSX.Fragment, null);
+    return (JSX.createElement("a", { href: `#${anchor}`, "aria-label": context.i18n.theme_permalink(), class: "tsd-anchor-icon" }, context.icons.anchor()));
 }

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

@@ -1,4 +1,4 @@
-import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-import { JSX } from "../../../../utils";
-import type { Reflection } from "../../../../models";
+import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
+import { JSX } from "../../../../utils/index.js";
+import type { Reflection } from "../../../../models/index.js";
 export declare const breadcrumb: (context: DefaultThemeRenderContext, props: Reflection) => JSX.Element | undefined;