typedoc 0.27.6 → 0.27.8

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

@@ -38,7 +38,7 @@ import { UrlMapping } from "../../models/UrlMapping.js";
 import { DefaultThemeRenderContext } from "./DefaultThemeRenderContext.js";
 import { filterMap, JSX, Option } from "../../../utils/index.js";
 import { classNames, getDisplayName, getHierarchyRoots, toStyleClass } from "../lib.js";
-import { icons } from "./partials/icon.js";
+import { getIcons } from "./partials/icon.js";
 import { Slugger } from "./Slugger.js";
 import { createNormalizedUrl } from "../../../utils/html.js";
 let DefaultTheme = (() => {
@@ -74,7 +74,7 @@ let DefaultTheme = (() => {
          * the icons used within the page, however TypeDoc currently assumes that all icons are svg
          * elements, so custom themes must also use svg elements.
          */
-        icons = { ...icons };
+        icons;
         getRenderContext(pageEvent) {
             return new DefaultThemeRenderContext(this, pageEvent, this.application.options);
         }
@@ -150,6 +150,7 @@ let DefaultTheme = (() => {
          */
         constructor(renderer) {
             super(renderer);
+            this.icons = getIcons(renderer.application.i18n);
             this.markedPlugin = renderer.markedPlugin;
         }
         /**
@@ -431,43 +432,51 @@ let DefaultTheme = (() => {
 })();
 export { DefaultTheme };
 function getReflectionClasses(reflection, filters) {
-    const classes = [];
+    const classes = new Set();
     // 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.flags.isInherited) {
-                classes.push("tsd-is-inherited");
+                classes.add("tsd-is-inherited");
             }
         }
         else if (key === "protected") {
             if (reflection.flags.isProtected) {
-                classes.push("tsd-is-protected");
+                classes.add("tsd-is-protected");
             }
         }
         else if (key === "private") {
             if (reflection.flags.isPrivate) {
-                classes.push("tsd-is-private");
+                classes.add("tsd-is-private");
             }
         }
         else if (key === "external") {
             if (reflection.flags.isExternal) {
-                classes.push("tsd-is-external");
+                classes.add("tsd-is-external");
             }
         }
         else if (key.startsWith("@")) {
             if (key === "@deprecated") {
                 if (reflection.isDeprecated()) {
-                    classes.push(toStyleClass(`tsd-is-${key.substring(1)}`));
+                    classes.add(toStyleClass(`tsd-is-${key.substring(1)}`));
                 }
             }
             else if (reflection.comment?.hasModifier(key) ||
                 reflection.comment?.getTag(key)) {
-                classes.push(toStyleClass(`tsd-is-${key.substring(1)}`));
+                classes.add(toStyleClass(`tsd-is-${key.substring(1)}`));
+            }
+            else if (reflection.isDeclaration()) {
+                const ownSignatures = reflection.getNonIndexSignatures();
+                // Check methods and accessors, find common tags, elevate
+                if (ownSignatures.length &&
+                    ownSignatures.every((refl) => refl.comment?.hasModifier(key) || refl.comment?.getTag(key))) {
+                    classes.add(toStyleClass(`tsd-is-${key.substring(1)}`));
+                }
             }
         }
     }
-    return classes.join(" ");
+    return Array.from(classes).join(" ");
 }
 function shouldShowCategories(reflection, opts) {
     if (opts.includeCategories) {

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

@@ -1,9 +1,9 @@
 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 { CommentDisplayPart, 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";
+import { type Icons } from "./partials/icon.js";
 export declare class DefaultThemeRenderContext {
     readonly theme: DefaultTheme;
     page: PageEvent<Reflection>;
@@ -18,7 +18,7 @@ export declare class DefaultThemeRenderContext {
      * Note: This creates a reference to icons declared by {@link DefaultTheme.icons},
      * to customize icons, that object must be modified instead.
      */
-    get icons(): Readonly<typeof icons>;
+    get icons(): Readonly<Icons>;
     get slugger(): import("./Slugger.js").Slugger;
     hook: Renderer["hooks"]["emit"];
     /** Avoid this in favor of urlTo if possible */
@@ -28,8 +28,8 @@ export declare class DefaultThemeRenderContext {
     /** 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.js").JsxElement;
+    getReflectionClasses: (refl: Reflection) => string;
+    documentTemplate: (props: PageEvent<import("../../../models/index.js").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;
@@ -67,19 +67,19 @@ export declare class DefaultThemeRenderContext {
     header: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements.js").JsxElement;
     hierarchy: (typeHierarchy: 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;
+    member: (props: import("../../../models/index.js").DeclarationReflection | import("../../../models/index.js").DocumentReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    moduleReflection: (mod: import("../../../models/index.js").DeclarationReflection | import("../../../models/index.js").ProjectReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    moduleMemberSummary: (member: import("../../../models/index.js").DeclarationReflection | import("../../../models/index.js").DocumentReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    memberDeclaration: (props: import("../../../models/index.js").DeclarationReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    memberGetterSetter: (props: import("../../../models/index.js").DeclarationReflection) => import("../../../utils/jsx.elements.js").JsxElement;
     memberSignatureBody: (props: import("../../../models/index.js").SignatureReflection, r_1?: {
         hideSources?: boolean;
     } | undefined) => import("../../../utils/jsx.elements.js").JsxElement;
     memberSignatureTitle: (props: import("../../../models/index.js").SignatureReflection, options?: {
         hideName?: boolean;
     } | 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;
+    memberSignatures: (props: import("../../../models/index.js").DeclarationReflection) => import("../../../utils/jsx.elements.js").JsxElement;
+    memberSources: (props: import("../../../models/index.js").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;

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

@@ -5,6 +5,9 @@ function favicon(context) {
     const fav = context.options.getValue("favicon");
     if (!fav)
         return null;
+    if (/^https?:\/\//i.test(fav)) {
+        return JSX.createElement("link", { rel: "icon", href: fav });
+    }
     switch (extname(fav)) {
         case ".ico":
             return JSX.createElement("link", { rel: "icon", href: context.relativeURL("assets/favicon.ico", true) });

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

@@ -1,5 +1,20 @@
 import { ReflectionKind } from "../../../../models/index.js";
 import { JSX } from "../../../../utils/index.js";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
-export declare function buildRefIcons<T extends Record<string, () => JSX.Element>>(icons: T, context: DefaultThemeRenderContext): T;
-export declare const icons: Record<ReflectionKind | "chevronDown" | "checkbox" | "menu" | "search" | "chevronSmall" | "anchor" | "folder" | "alertNote" | "alertTip" | "alertImportant" | "alertWarning" | "alertCaution", () => JSX.Element>;
+import type { TranslationProxy } from "../../../../internationalization/index.js";
+export declare function buildRefIcons(icons: Icons, context: DefaultThemeRenderContext): Icons;
+export interface Icons extends Record<ReflectionKind, () => JSX.Element> {
+    chevronDown(): JSX.Element;
+    checkbox(): JSX.Element;
+    menu(): JSX.Element;
+    search(): JSX.Element;
+    chevronSmall(): JSX.Element;
+    anchor(): JSX.Element;
+    folder(): JSX.Element;
+    alertNote(): JSX.Element;
+    alertTip(): JSX.Element;
+    alertImportant(): JSX.Element;
+    alertWarning(): JSX.Element;
+    alertCaution(): JSX.Element;
+}
+export declare function getIcons(i18n: TranslationProxy): Icons;

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

@@ -3,10 +3,10 @@
 import assert from "assert";
 import { ReflectionKind } from "../../../../models/index.js";
 import { JSX } from "../../../../utils/index.js";
-const kindIcon = (letterPath, color, circular = false) => (JSX.createElement("svg", { class: "tsd-kind-icon", viewBox: "0 0 24 24" },
+const kindIcon = (letterPath, color, label, circular = false) => (JSX.createElement("svg", { class: "tsd-kind-icon", viewBox: "0 0 24 24", "aria-label": label },
     JSX.createElement("rect", { fill: "var(--color-icon-background)", stroke: color, "stroke-width": "1.5", x: "1", y: "1", width: "22", height: "22", rx: circular ? "12" : "6" }),
     letterPath));
-const textIcon = (letter, color, circular = false) => kindIcon(JSX.createElement("text", { fill: "var(--color-icon-text)", x: "50%", y: "50%", "dominant-baseline": "central", "text-anchor": "middle" }, letter), color, circular);
+const textIcon = (letter, color, label, circular = false) => kindIcon(JSX.createElement("text", { fill: "var(--color-icon-text)", x: "50%", y: "50%", "dominant-baseline": "central", "text-anchor": "middle" }, letter), color, label, circular);
 export function buildRefIcons(icons, context) {
     const refs = {};
     for (const [name, builder] of Object.entries(icons)) {
@@ -24,80 +24,78 @@ export function buildRefIcons(icons, context) {
     }
     return refs;
 }
-export const icons = {
-    [ReflectionKind.Accessor]: () => textIcon("A", "var(--color-ts-accessor)", true),
-    [ReflectionKind.CallSignature]() {
-        return this[ReflectionKind.Function]();
-    },
-    [ReflectionKind.Class]: () => textIcon("C", "var(--color-ts-class)"),
-    [ReflectionKind.Constructor]: () => textIcon("C", "var(--color-ts-constructor)", true),
-    [ReflectionKind.ConstructorSignature]() {
-        return this[ReflectionKind.Constructor]();
-    },
-    [ReflectionKind.Enum]: () => textIcon("E", "var(--color-ts-enum)"),
-    [ReflectionKind.EnumMember]() {
-        return this[ReflectionKind.Property]();
-    },
-    [ReflectionKind.Function]: () => textIcon("F", "var(--color-ts-function)"),
-    [ReflectionKind.GetSignature]() {
-        return this[ReflectionKind.Accessor]();
-    },
-    [ReflectionKind.IndexSignature]() {
-        return this[ReflectionKind.Property]();
-    },
-    [ReflectionKind.Interface]: () => textIcon("I", "var(--color-ts-interface)"),
-    [ReflectionKind.Method]: () => textIcon("M", "var(--color-ts-method)", true),
-    [ReflectionKind.Module]: () => textIcon("M", "var(--color-ts-module)"),
-    [ReflectionKind.Namespace]: () => textIcon("N", "var(--color-ts-namespace)"),
-    [ReflectionKind.Parameter]() {
-        return this[ReflectionKind.Property]();
-    },
-    [ReflectionKind.Project]() {
-        return this[ReflectionKind.Module]();
-    },
-    [ReflectionKind.Property]: () => textIcon("P", "var(--color-ts-property)", true),
-    [ReflectionKind.Reference]: () => textIcon("R", "var(--color-ts-reference)", true),
-    [ReflectionKind.SetSignature]() {
-        return this[ReflectionKind.Accessor]();
-    },
-    [ReflectionKind.TypeAlias]: () => textIcon("T", "var(--color-ts-type-alias)"),
-    [ReflectionKind.TypeLiteral]() {
-        return this[ReflectionKind.TypeAlias]();
-    },
-    [ReflectionKind.TypeParameter]() {
-        return this[ReflectionKind.TypeAlias]();
-    },
-    [ReflectionKind.Variable]: () => textIcon("V", "var(--color-ts-variable)"),
-    [ReflectionKind.Document]: () => kindIcon(JSX.createElement("g", { stroke: "var(--color-icon-text)", fill: "none", "stroke-width": "1.5" },
-        JSX.createElement("polygon", { points: "6,5 6,19 18,19, 18,10 13,5" }),
-        JSX.createElement("line", { x1: "9", y1: "9", x2: "13", y2: "9" }),
-        JSX.createElement("line", { x1: "9", y1: "12", x2: "15", y2: "12" }),
-        JSX.createElement("line", { x1: "9", y1: "15", x2: "15", y2: "15" })), "var(--color-document)"),
-    folder: () => kindIcon(JSX.createElement("g", { stroke: "var(--color-icon-text)", fill: "none", "stroke-width": "1.5" },
-        JSX.createElement("polygon", { points: "5,5 10,5 12,8 19,8 19,18 5,18" })), "var(--color-document)"),
-    chevronDown: () => (JSX.createElement("svg", { width: "20", height: "20", viewBox: "0 0 24 24", fill: "none" },
-        JSX.createElement("path", { d: "M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z", fill: "var(--color-icon-text)" }))),
-    chevronSmall: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none" },
-        JSX.createElement("path", { d: "M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z", fill: "var(--color-icon-text)" }))),
-    checkbox: () => (JSX.createElement("svg", { width: "32", height: "32", viewBox: "0 0 32 32", "aria-hidden": "true" },
-        JSX.createElement("rect", { class: "tsd-checkbox-background", width: "30", height: "30", x: "1", y: "1", rx: "6", fill: "none" }),
-        JSX.createElement("path", { class: "tsd-checkbox-checkmark", d: "M8.35422 16.8214L13.2143 21.75L24.6458 10.25", stroke: "none", "stroke-width": "3.5", "stroke-linejoin": "round", fill: "none" }))),
-    menu: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none" }, ["3", "7", "11"].map((y) => (JSX.createElement("rect", { x: "1", y: y, width: "14", height: "2", fill: "var(--color-icon-text)" }))))),
-    search: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none" },
-        JSX.createElement("path", { d: "M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z", fill: "var(--color-icon-text)" }))),
-    anchor: () => (JSX.createElement("svg", { viewBox: "0 0 24 24" },
-        JSX.createElement("g", { "stroke-width": "2", stroke: "currentColor", fill: "none", "stroke-linecap": "round", "stroke-linejoin": "round" },
-            JSX.createElement("path", { stroke: "none", d: "M0 0h24v24H0z", fill: "none" }),
-            JSX.createElement("path", { d: "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" }),
-            JSX.createElement("path", { d: "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" })))),
-    alertNote: () => (JSX.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", width: "16", height: "16", viewBox: "0 0 16 16" },
-        JSX.createElement("path", { fill: "var(--color-alert-note)", d: "M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z" }))),
-    alertTip: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16" },
-        JSX.createElement("path", { fill: "var(--color-alert-tip)", d: "M8 1.5c-2.363 0-4 1.69-4 3.75 0 .984.424 1.625.984 2.304l.214.253c.223.264.47.556.673.848.284.411.537.896.621 1.49a.75.75 0 0 1-1.484.211c-.04-.282-.163-.547-.37-.847a8.456 8.456 0 0 0-.542-.68c-.084-.1-.173-.205-.268-.32C3.201 7.75 2.5 6.766 2.5 5.25 2.5 2.31 4.863 0 8 0s5.5 2.31 5.5 5.25c0 1.516-.701 2.5-1.328 3.259-.095.115-.184.22-.268.319-.207.245-.383.453-.541.681-.208.3-.33.565-.37.847a.751.751 0 0 1-1.485-.212c.084-.593.337-1.078.621-1.489.203-.292.45-.584.673-.848.075-.088.147-.173.213-.253.561-.679.985-1.32.985-2.304 0-2.06-1.637-3.75-4-3.75ZM5.75 12h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1 0-1.5ZM6 15.25a.75.75 0 0 1 .75-.75h2.5a.75.75 0 0 1 0 1.5h-2.5a.75.75 0 0 1-.75-.75Z" }))),
-    alertImportant: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16" },
-        JSX.createElement("path", { fill: "var(--color-alert-important)", d: "M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" }))),
-    alertWarning: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16" },
-        JSX.createElement("path", { fill: "var(--color-alert-warning)", d: "M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" }))),
-    alertCaution: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16" },
-        JSX.createElement("path", { fill: "var(--color-alert-caution)", d: "M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z" }))),
-};
+export function getIcons(i18n) {
+    return {
+        [ReflectionKind.Accessor]: () => textIcon("A", "var(--color-ts-accessor)", i18n.kind_accessor(), true),
+        [ReflectionKind.CallSignature]() {
+            return this[ReflectionKind.Function]();
+        },
+        [ReflectionKind.Class]: () => textIcon("C", "var(--color-ts-class)", i18n.kind_class()),
+        [ReflectionKind.Constructor]: () => textIcon("C", "var(--color-ts-constructor)", i18n.kind_constructor(), true),
+        [ReflectionKind.ConstructorSignature]() {
+            return this[ReflectionKind.Constructor]();
+        },
+        [ReflectionKind.Enum]: () => textIcon("E", "var(--color-ts-enum)", i18n.kind_enum()),
+        [ReflectionKind.EnumMember]: () => textIcon("P", "var(--color-ts-property)", i18n.kind_enum_member(), true),
+        [ReflectionKind.Function]: () => textIcon("F", "var(--color-ts-function)", i18n.kind_function()),
+        [ReflectionKind.GetSignature]() {
+            return this[ReflectionKind.Accessor]();
+        },
+        [ReflectionKind.IndexSignature]: () => textIcon("P", "var(--color-ts-property)", i18n.kind_index_signature(), true),
+        [ReflectionKind.Interface]: () => textIcon("I", "var(--color-ts-interface)", i18n.kind_interface()),
+        [ReflectionKind.Method]: () => textIcon("M", "var(--color-ts-method)", i18n.kind_method(), true),
+        [ReflectionKind.Module]: () => textIcon("M", "var(--color-ts-module)", i18n.kind_module()),
+        [ReflectionKind.Namespace]: () => textIcon("N", "var(--color-ts-namespace)", i18n.kind_namespace()),
+        [ReflectionKind.Parameter]() {
+            return this[ReflectionKind.Property]();
+        },
+        [ReflectionKind.Project]() {
+            return this[ReflectionKind.Module]();
+        },
+        [ReflectionKind.Property]: () => textIcon("P", "var(--color-ts-property)", i18n.kind_property(), true),
+        [ReflectionKind.Reference]: () => textIcon("R", "var(--color-ts-reference)", i18n.kind_reference(), true),
+        [ReflectionKind.SetSignature]() {
+            return this[ReflectionKind.Accessor]();
+        },
+        [ReflectionKind.TypeAlias]: () => textIcon("T", "var(--color-ts-type-alias)", i18n.kind_type_alias()),
+        [ReflectionKind.TypeLiteral]() {
+            return this[ReflectionKind.TypeAlias]();
+        },
+        [ReflectionKind.TypeParameter]() {
+            return this[ReflectionKind.TypeAlias]();
+        },
+        [ReflectionKind.Variable]: () => textIcon("V", "var(--color-ts-variable)", i18n.kind_variable()),
+        [ReflectionKind.Document]: () => kindIcon(JSX.createElement("g", { stroke: "var(--color-icon-text)", fill: "none", "stroke-width": "1.5" },
+            JSX.createElement("polygon", { points: "6,5 6,19 18,19, 18,10 13,5" }),
+            JSX.createElement("line", { x1: "9", y1: "9", x2: "13", y2: "9" }),
+            JSX.createElement("line", { x1: "9", y1: "12", x2: "15", y2: "12" }),
+            JSX.createElement("line", { x1: "9", y1: "15", x2: "15", y2: "15" })), "var(--color-document)", i18n.kind_document()),
+        folder: () => kindIcon(JSX.createElement("g", { stroke: "var(--color-icon-text)", fill: "none", "stroke-width": "1.5" },
+            JSX.createElement("polygon", { points: "5,5 10,5 12,8 19,8 19,18 5,18" })), "var(--color-document)", i18n.theme_folder()),
+        chevronDown: () => (JSX.createElement("svg", { width: "20", height: "20", viewBox: "0 0 24 24", fill: "none", "aria-hidden": "true" },
+            JSX.createElement("path", { d: "M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z", fill: "var(--color-icon-text)" }))),
+        chevronSmall: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none", "aria-hidden": "true" },
+            JSX.createElement("path", { d: "M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z", fill: "var(--color-icon-text)" }))),
+        checkbox: () => (JSX.createElement("svg", { width: "32", height: "32", viewBox: "0 0 32 32", "aria-hidden": "true" },
+            JSX.createElement("rect", { class: "tsd-checkbox-background", width: "30", height: "30", x: "1", y: "1", rx: "6", fill: "none" }),
+            JSX.createElement("path", { class: "tsd-checkbox-checkmark", d: "M8.35422 16.8214L13.2143 21.75L24.6458 10.25", stroke: "none", "stroke-width": "3.5", "stroke-linejoin": "round", fill: "none" }))),
+        menu: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none", "aria-hidden": "true" }, ["3", "7", "11"].map((y) => (JSX.createElement("rect", { x: "1", y: y, width: "14", height: "2", fill: "var(--color-icon-text)" }))))),
+        search: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none", "aria-hidden": "true" },
+            JSX.createElement("path", { d: "M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z", fill: "var(--color-icon-text)" }))),
+        anchor: () => (JSX.createElement("svg", { viewBox: "0 0 24 24", "aria-hidden": "true" },
+            JSX.createElement("g", { "stroke-width": "2", stroke: "currentColor", fill: "none", "stroke-linecap": "round", "stroke-linejoin": "round" },
+                JSX.createElement("path", { stroke: "none", d: "M0 0h24v24H0z", fill: "none" }),
+                JSX.createElement("path", { d: "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" }),
+                JSX.createElement("path", { d: "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" })))),
+        alertNote: () => (JSX.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", width: "16", height: "16", viewBox: "0 0 16 16", "aria-hidden": "true" },
+            JSX.createElement("path", { fill: "var(--color-alert-note)", d: "M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z" }))),
+        alertTip: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", "aria-hidden": "true" },
+            JSX.createElement("path", { fill: "var(--color-alert-tip)", d: "M8 1.5c-2.363 0-4 1.69-4 3.75 0 .984.424 1.625.984 2.304l.214.253c.223.264.47.556.673.848.284.411.537.896.621 1.49a.75.75 0 0 1-1.484.211c-.04-.282-.163-.547-.37-.847a8.456 8.456 0 0 0-.542-.68c-.084-.1-.173-.205-.268-.32C3.201 7.75 2.5 6.766 2.5 5.25 2.5 2.31 4.863 0 8 0s5.5 2.31 5.5 5.25c0 1.516-.701 2.5-1.328 3.259-.095.115-.184.22-.268.319-.207.245-.383.453-.541.681-.208.3-.33.565-.37.847a.751.751 0 0 1-1.485-.212c.084-.593.337-1.078.621-1.489.203-.292.45-.584.673-.848.075-.088.147-.173.213-.253.561-.679.985-1.32.985-2.304 0-2.06-1.637-3.75-4-3.75ZM5.75 12h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1 0-1.5ZM6 15.25a.75.75 0 0 1 .75-.75h2.5a.75.75 0 0 1 0 1.5h-2.5a.75.75 0 0 1-.75-.75Z" }))),
+        alertImportant: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", "aria-hidden": "true" },
+            JSX.createElement("path", { fill: "var(--color-alert-important)", d: "M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" }))),
+        alertWarning: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", "aria-hidden": "true" },
+            JSX.createElement("path", { fill: "var(--color-alert-warning)", d: "M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" }))),
+        alertCaution: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", "aria-hidden": "true" },
+            JSX.createElement("path", { fill: "var(--color-alert-caution)", d: "M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z" }))),
+    };
+}

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

@@ -4,9 +4,9 @@ export const memberGetterSetter = (context, props) => (JSX.createElement(JSX.Fra
     JSX.createElement("ul", { class: classNames({
             "tsd-signatures": true,
         }, context.getReflectionClasses(props)) },
-        !!props.getSignature && (JSX.createElement(JSX.Fragment, null,
-            JSX.createElement("li", { class: "tsd-signature", id: props.getSignature.anchor }, context.memberSignatureTitle(props.getSignature)),
-            JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(props.getSignature)))),
-        !!props.setSignature && (JSX.createElement(JSX.Fragment, null,
-            JSX.createElement("li", { class: "tsd-signature", id: props.setSignature.anchor }, context.memberSignatureTitle(props.setSignature)),
-            JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(props.setSignature)))))));
+        !!props.getSignature && (JSX.createElement("li", { class: context.getReflectionClasses(props.getSignature) },
+            JSX.createElement("div", { class: "tsd-signature", id: props.getSignature.anchor }, context.memberSignatureTitle(props.getSignature)),
+            JSX.createElement("div", { class: "tsd-description" }, context.memberSignatureBody(props.getSignature)))),
+        !!props.setSignature && (JSX.createElement("li", { class: context.getReflectionClasses(props.setSignature) },
+            JSX.createElement("div", { class: "tsd-signature", id: props.setSignature.anchor }, context.memberSignatureTitle(props.setSignature)),
+            JSX.createElement("div", { class: "tsd-description" }, context.memberSignatureBody(props.setSignature)))))));

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

@@ -2,9 +2,9 @@ import { JSX } from "../../../../utils/index.js";
 import { anchorIcon } from "./anchor-icon.js";
 import { classNames } from "../../lib.js";
 export const memberSignatures = (context, props) => (JSX.createElement(JSX.Fragment, null,
-    JSX.createElement("ul", { class: classNames({ "tsd-signatures": true }, context.getReflectionClasses(props)) }, props.signatures?.map((item) => (JSX.createElement(JSX.Fragment, null,
-        JSX.createElement("li", { class: "tsd-signature tsd-anchor-link" },
+    JSX.createElement("ul", { class: classNames({ "tsd-signatures": true }, context.getReflectionClasses(props)) }, props.signatures?.map((item) => (JSX.createElement("li", { class: context.getReflectionClasses(item) },
+        JSX.createElement("div", { class: "tsd-signature tsd-anchor-link" },
             item.anchor && JSX.createElement("a", { id: item.anchor, class: "tsd-anchor" }),
             context.memberSignatureTitle(item),
             anchorIcon(context, item.anchor)),
-        JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(item))))))));
+        JSX.createElement("div", { class: "tsd-description" }, context.memberSignatureBody(item))))))));

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

@@ -28,7 +28,7 @@ export function reflectionTemplate(context, props) {
                 JSX.createElement("h4", null, context.i18n.theme_implemented_by()),
                 JSX.createElement("ul", { class: "tsd-hierarchy" }, props.model.implementedBy.map((item) => (JSX.createElement("li", null, context.type(item))))))),
             !!props.model.signatures?.length && (JSX.createElement("section", { class: "tsd-panel" }, context.memberSignatures(props.model))),
-            !!props.model.indexSignatures?.length && (JSX.createElement("section", { class: classNames({ "tsd-panel": true }, context.getReflectionClasses(props.model)) },
+            !!props.model.indexSignatures?.length && (JSX.createElement("section", { class: "tsd-panel" },
                 JSX.createElement("h4", { class: "tsd-before-signature" }, context.i18n.theme_indexable()),
                 JSX.createElement("ul", { class: "tsd-signatures" }, props.model.indexSignatures.map((index) => renderIndexSignature(context, index))))),
             !props.model.signatures && context.memberSources(props.model))),
@@ -36,7 +36,7 @@ export function reflectionTemplate(context, props) {
         context.members(props.model)));
 }
 function renderIndexSignature(context, index) {
-    return (JSX.createElement("li", { class: "tsd-index-signature" },
+    return (JSX.createElement("li", { class: classNames({ "tsd-index-signature": true }, context.getReflectionClasses(index)) },
         JSX.createElement("div", { class: "tsd-signature" },
             index.flags.isReadonly && JSX.createElement("span", { class: "tsd-signature-keyword" }, "readonly "),
             JSX.createElement("span", { class: "tsd-signature-symbol" }, "["),

package/dist/lib/utils/fs.d.ts

@@ -57,11 +57,11 @@ export declare function discoverInParentDir<T extends {}>(name: string, dir: str
     file: string;
     content: T;
 } | undefined;
-export declare function discoverInParentDirExactMatch<T extends {}>(name: string, dir: string, read: (content: string) => T | undefined): {
+export declare function discoverInParentDirExactMatch<T extends {}>(name: string, dir: string, read: (content: string) => T | undefined, usedFile?: (path: string) => void): {
     file: string;
     content: T;
 } | undefined;
-export declare function discoverPackageJson(dir: string): {
+export declare function discoverPackageJson(dir: string, usedFile?: (path: string) => void): {
     file: string;
     content: {
         version?: string | undefined;

package/dist/lib/utils/fs.js

@@ -278,11 +278,12 @@ export function discoverInParentDir(name, dir, read) {
         dir = resolve(join(dir, ".."));
     }
 }
-export function discoverInParentDirExactMatch(name, dir, read) {
+export function discoverInParentDirExactMatch(name, dir, read, usedFile) {
     if (!isDir(dir))
         return;
     const reachedTopDirectory = (dirName) => dirName === resolve(join(dirName, ".."));
     while (!reachedTopDirectory(dir)) {
+        usedFile?.(join(dir, name));
         try {
             const content = read(readFile(join(dir, name)));
             if (content != null) {
@@ -295,13 +296,13 @@ export function discoverInParentDirExactMatch(name, dir, read) {
         dir = resolve(join(dir, ".."));
     }
 }
-export function discoverPackageJson(dir) {
+export function discoverPackageJson(dir, usedFile) {
     return discoverInParentDirExactMatch("package.json", dir, (content) => {
         const pkg = JSON.parse(content);
         if (validate({ name: String, version: optional(String) }, pkg)) {
             return pkg;
         }
-    });
+    }, usedFile);
 }
 // dir -> package name according to package.json in this or some parent dir
 const packageCache = new Map();

package/dist/lib/utils/general.d.ts

@@ -41,6 +41,7 @@ export type Chars<T extends string> = T extends `${infer C}${infer R}` ? C | Cha
 export declare function assertNever(x: never): never;
 export declare function escapeRegExp(s: string): string;
 export declare function editDistance(s: string, t: string): number;
+export declare function dedent(text: string): string;
 export declare function getSimilarValues(values: Iterable<string>, compareTo: string): string[];
 export declare function NonEnumerable(_cls: unknown, context: ClassFieldDecoratorContext): void;
 export declare const TYPEDOC_ROOT: string;

package/dist/lib/utils/general.js

@@ -40,6 +40,17 @@ export function editDistance(s, t) {
     }
     return v0[t.length];
 }
+export function dedent(text) {
+    const lines = text.split(/\r?\n/);
+    while (lines.length && lines[0].search(/\S/) === -1) {
+        lines.shift();
+    }
+    while (lines.length && lines[lines.length - 1].search(/\S/) === -1) {
+        lines.pop();
+    }
+    const minIndent = lines.reduce((indent, line) => line.length ? Math.min(indent, line.search(/\S/)) : indent, Infinity);
+    return lines.map((line) => line.substring(minIndent)).join("\n");
+}
 export function getSimilarValues(values, compareTo) {
     const results = new DefaultMap(() => []);
     let lowest = Infinity;

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

@@ -198,6 +198,7 @@ export interface TypeDocOptionMap {
     intentionallyNotExported: string[];
     validation: ValidationOptions;
     requiredToBeDocumented: ReflectionKind.KindString[];
+    intentionallyNotDocumented: string[];
     watch: boolean;
     preserveWatchOutput: boolean;
     help: boolean;
@@ -276,31 +277,35 @@ export declare enum ParameterType {
      * Resolved according to the config directory.
      */
     Path = 1,
-    Number = 2,
-    Boolean = 3,
-    Map = 4,
-    Mixed = 5,
-    Array = 6,
+    /**
+     * Resolved according to the config directory unless it starts with https?://
+     */
+    UrlOrPath = 2,
+    Number = 3,
+    Boolean = 4,
+    Map = 5,
+    Mixed = 6,
+    Array = 7,
     /**
      * Resolved according to the config directory.
      */
-    PathArray = 7,
+    PathArray = 8,
     /**
      * Resolved according to the config directory if it starts with `.`
      */
-    ModuleArray = 8,
+    ModuleArray = 9,
     /**
      * Resolved according to the config directory unless it starts with `**`, after skipping any leading `!` and `#` characters.
      */
-    GlobArray = 9,
+    GlobArray = 10,
     /**
      * An object which partially merges user-set values into the defaults.
      */
-    Object = 10,
+    Object = 11,
     /**
      * An object with true/false flags
      */
-    Flags = 11
+    Flags = 12
 }
 export interface DeclarationOptionBase {
     /**
@@ -331,9 +336,9 @@ export interface StringDeclarationOption extends DeclarationOptionBase {
      * Specifies the resolution strategy. If `Path` is provided, values will be resolved according to their
      * location in a file. If `String` or no value is provided, values will not be resolved.
      */
-    type?: ParameterType.String | ParameterType.Path;
+    type?: ParameterType.String | ParameterType.Path | ParameterType.UrlOrPath;
     /**
-     * If not specified defaults to the empty string for both `String` and `Path`.
+     * If not specified defaults to the empty string for all types.
      */
     defaultValue?: string;
     /**
@@ -443,6 +448,7 @@ export type DeclarationOption = StringDeclarationOption | NumberDeclarationOptio
 export interface ParameterTypeToOptionTypeMap {
     [ParameterType.String]: string;
     [ParameterType.Path]: string;
+    [ParameterType.UrlOrPath]: string;
     [ParameterType.Number]: number;
     [ParameterType.Boolean]: boolean;
     [ParameterType.Mixed]: unknown;