typedoc 0.26.1 → 0.26.3

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

@@ -86,7 +86,7 @@ function pageSidebar(context, props) {
         context.settings(),
         context.pageNavigation(props)));
 }
-function pageNavigation(context, props) {
+function buildSectionNavigation(context, headings) {
     const levels = [[]];
     function finalizeLevel(finishedHandlingHeadings) {
         const level = levels.pop();
@@ -97,8 +97,12 @@ function pageNavigation(context, props) {
         const built = (utils_1.JSX.createElement("ul", null, level.map((l) => (utils_1.JSX.createElement("li", null, l)))));
         levels[levels.length - 1].push(built);
     }
-    for (const heading of props.pageHeadings) {
-        const inferredLevel = heading.level ? heading.level + 1 : 1;
+    for (const heading of headings) {
+        const inferredLevel = heading.level
+            ? heading.level + 2 // regular heading
+            : heading.kind
+                ? 2 // reflection
+                : 1; // group/category
         while (inferredLevel < levels.length) {
             finalizeLevel(false);
         }
@@ -113,15 +117,31 @@ function pageNavigation(context, props) {
     while (levels.length > 1) {
         finalizeLevel(true);
     }
-    if (!levels[0].length) {
-        return utils_1.JSX.createElement(utils_1.JSX.Fragment, null);
-    }
     levels.unshift([]);
     finalizeLevel(true);
+    return levels[0];
+}
+function pageNavigation(context, props) {
+    if (!props.pageSections.some((sect) => sect.headings.length)) {
+        return utils_1.JSX.createElement(utils_1.JSX.Fragment, null);
+    }
+    const sections = [];
+    for (const section of props.pageSections) {
+        if (section.title) {
+            sections.push(utils_1.JSX.createElement("details", { open: true, class: "tsd-accordion tsd-page-navigation-section" },
+                utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": `tsd-otp-${section.title}` },
+                    context.icons.chevronDown(),
+                    section.title),
+                utils_1.JSX.createElement("div", null, buildSectionNavigation(context, section.headings))));
+        }
+        else {
+            sections.push(buildSectionNavigation(context, section.headings));
+        }
+    }
     return (utils_1.JSX.createElement("details", { open: true, class: "tsd-accordion tsd-page-navigation" },
         utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary" },
             utils_1.JSX.createElement("h3", null,
                 context.icons.chevronDown(),
                 context.i18n.theme_on_this_page())),
-        utils_1.JSX.createElement("div", { class: "tsd-accordion-details" }, levels[0])));
+        utils_1.JSX.createElement("div", { class: "tsd-accordion-details" }, sections)));
 }

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

@@ -1,3 +1,4 @@
+export declare const emptyArray: readonly [];
 /**
  * Inserts an item into an array sorted by priority. If two items have the same priority,
  * the item will be inserted later will be placed earlier in the array.
@@ -48,3 +49,5 @@ export declare function zip<T extends Iterable<any>[]>(...args: T): Iterable<{
     [K in keyof T]: T[K] extends Iterable<infer U> ? U : T[K];
 }>;
 export declare function filterMap<T, U>(iter: Iterable<T>, fn: (item: T) => U | undefined): U[];
+export declare function firstDefined<T, U>(array: readonly T[] | undefined, callback: (element: T, index: number) => U | undefined): U | undefined;
+export declare function filter<T>(array: readonly T[] | undefined, predicate: (value: T, index: number, array: readonly T[]) => boolean): readonly T[];

package/dist/lib/utils/array.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.emptyArray = void 0;
 exports.insertPrioritySorted = insertPrioritySorted;
 exports.insertOrderSorted = insertOrderSorted;
 exports.binaryFindPartition = binaryFindPartition;
@@ -9,6 +10,9 @@ exports.unique = unique;
 exports.partition = partition;
 exports.zip = zip;
 exports.filterMap = filterMap;
+exports.firstDefined = firstDefined;
+exports.filter = filter;
+exports.emptyArray = [];
 /**
  * Inserts an item into an array sorted by priority. If two items have the same priority,
  * the item will be inserted later will be placed earlier in the array.
@@ -123,3 +127,18 @@ function filterMap(iter, fn) {
     }
     return result;
 }
+function firstDefined(array, callback) {
+    if (array === undefined) {
+        return undefined;
+    }
+    for (let i = 0; i < array.length; i++) {
+        const result = callback(array[i], i);
+        if (result !== undefined) {
+            return result;
+        }
+    }
+    return undefined;
+}
+function filter(array, predicate) {
+    return array ? array.filter(predicate) : exports.emptyArray;
+}

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

@@ -4,6 +4,6 @@ export declare function hasAllFlags(flags: number, check: number): boolean;
 export declare function hasAnyFlag(flags: number, check: number): boolean;
 export declare function debugFlags(Enum: {}, flags: number): string[];
 export declare function getEnumKeys(Enum: {}): string[];
-export type EnumKeys<E extends {}> = keyof {
-    [K in keyof E as number extends E[K] ? K : never]: 1;
-};
+export type EnumKeys<E extends {}> = {
+    [K in keyof E]: number extends E[K] ? K : never;
+}[keyof E] & {};

package/dist/lib/utils/highlighter.js

@@ -152,7 +152,7 @@ function getSupportedThemes() {
     return supportedThemes;
 }
 function isLoadedLanguage(lang) {
-    return highlighter?.supports(lang) ?? false;
+    return lang === "text" || (highlighter?.supports(lang) ?? false);
 }
 function highlight(code, lang) {
     (0, assert_1.ok)(highlighter, "Tried to highlight with an uninitialized highlighter");

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

@@ -73,7 +73,7 @@ export interface TypeDocOptionMap {
     externalPattern: string[];
     excludeExternals: boolean;
     excludeNotDocumented: boolean;
-    excludeNotDocumentedKinds: Array<keyof typeof ReflectionKind>;
+    excludeNotDocumentedKinds: ReflectionKind.KindString[];
     excludeInternal: boolean;
     excludePrivate: boolean;
     excludeProtected: boolean;
@@ -155,6 +155,7 @@ export interface TypeDocOptionMap {
     useTsLinkResolution: boolean;
     preserveLinkText: boolean;
     jsDocCompatibility: JsDocCompatibility;
+    suppressCommentWarningsInDeclarationFiles: boolean;
     blockTags: `@${string}`[];
     inlineTags: `@${string}`[];
     modifierTags: `@${string}`[];

package/dist/lib/utils/options/sources/typedoc.js

@@ -610,6 +610,11 @@ function addTypeDocOptions(options) {
             ignoreUnescapedBraces: true,
         },
     });
+    options.addDeclaration({
+        name: "suppressCommentWarningsInDeclarationFiles",
+        help: (i18n) => i18n.help_lang(),
+        type: declaration_1.ParameterType.Boolean,
+    });
     options.addDeclaration({
         name: "commentStyle",
         help: (i18n) => i18n.help_commentStyle(),

package/dist/lib/utils/options/tsdoc-defaults.d.ts

@@ -1,5 +1,5 @@
 export declare const tsdocBlockTags: readonly ["@defaultValue", "@deprecated", "@example", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam"];
-export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@example", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam", "@author", "@callback", "@category", "@categoryDescription", "@default", "@document", "@group", "@groupDescription", "@import", "@inheritDoc", "@jsx", "@license", "@module", "@prop", "@property", "@return", "@satisfies", "@template", "@type", "@typedef"];
+export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@example", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam", "@author", "@callback", "@category", "@categoryDescription", "@default", "@document", "@group", "@groupDescription", "@import", "@inheritDoc", "@jsx", "@license", "@module", "@prop", "@property", "@return", "@satisfies", "@since", "@template", "@type", "@typedef"];
 export declare const tsdocInlineTags: readonly ["@link", "@inheritDoc", "@label"];
 export declare const inlineTags: readonly ["@link", "@inheritDoc", "@label", "@linkcode", "@linkplain"];
 export declare const tsdocModifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual"];

package/dist/lib/utils/options/tsdoc-defaults.js

@@ -33,8 +33,9 @@ exports.blockTags = [
     "@property",
     "@return",
     "@satisfies",
+    "@since",
     "@template", // Alias for @typeParam
-    "@type", // Because TypeScript is important!
+    "@type",
     "@typedef",
 ];
 exports.tsdocInlineTags = ["@link", "@inheritDoc", "@label"];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.26.1",
+  "version": "0.26.3",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -26,8 +26,8 @@
   "dependencies": {
     "lunr": "^2.3.9",
     "markdown-it": "^14.1.0",
-    "minimatch": "^9.0.4",
-    "shiki": "^1.9.0",
+    "minimatch": "^9.0.5",
+    "shiki": "^1.9.1",
     "yaml": "^2.4.5"
   },
   "peerDependencies": {
@@ -36,18 +36,18 @@
   "devDependencies": {
     "@types/lunr": "^2.3.7",
     "@types/markdown-it": "^14.1.1",
-    "@types/mocha": "^10.0.6",
+    "@types/mocha": "^10.0.7",
     "@types/node": "18",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#34113409e3a171e68ce5e2b55461ef5c35591cfe",
     "c8": "^10.1.2",
     "esbuild": "^0.21.5",
     "eslint": "^9.5.0",
-    "mocha": "^10.4.0",
+    "mocha": "^10.5.2",
     "prettier": "3.3.2",
-    "puppeteer": "^22.12.0",
+    "puppeteer": "^22.12.1",
     "ts-node": "^10.9.2",
     "typescript": "5.5.2",
-    "typescript-eslint": "^7.13.1"
+    "typescript-eslint": "^7.14.1"
   },
   "files": [
     "/bin",

package/static/style.css

@@ -793,6 +793,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
     margin-left: -1.5rem;
 }
 
+.tsd-page-navigation-section {
+    margin-left: 10px;
+}
+.tsd-page-navigation-section > summary {
+    padding: 0.25rem;
+}
+.tsd-page-navigation-section > div {
+    margin-left: 20px;
+}
 .tsd-page-navigation ul {
     padding-left: 1.75rem;
 }
@@ -841,6 +850,7 @@ a.tsd-index-link {
 }
 .tsd-accordion .tsd-accordion-summary > svg {
     margin-left: 0.25rem;
+    vertical-align: text-top;
 }
 .tsd-index-content > :not(:first-child) {
     margin-top: 0.75rem;

package/tsdoc.json

@@ -115,6 +115,10 @@
             "tagName": "@satisfies",
             "syntaxKind": "block"
         },
+        {
+            "tagName": "@since",
+            "syntaxKind": "block"
+        },
         {
             "tagName": "@license",
             "syntaxKind": "block"

package/dist/lib/output/themes/default/partials/members.group.d.ts

@@ -1,4 +0,0 @@
-import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-import { JSX } from "../../../../utils";
-import type { ReflectionGroup } from "../../../../models";
-export declare function membersGroup(context: DefaultThemeRenderContext, group: ReflectionGroup): JSX.Element;

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

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.membersGroup = membersGroup;
-const utils_1 = require("../../../../utils");
-function membersGroup(context, group) {
-    if (group.categories) {
-        return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, group.categories.map((item) => {
-            const title = `${group.title} - ${item.title}`;
-            return (utils_1.JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
-                utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + title },
-                    utils_1.JSX.createElement("h2", null,
-                        context.icons.chevronDown(),
-                        " ",
-                        title)),
-                utils_1.JSX.createElement("section", null, item.children.map((item) => !item.hasOwnDocument && context.member(item)))));
-        })));
-    }
-    return (utils_1.JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
-        utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + group.title },
-            utils_1.JSX.createElement("h2", null,
-                context.icons.chevronDown(),
-                " ",
-                group.title)),
-        utils_1.JSX.createElement("section", null, group.children.map((item) => !item.hasOwnDocument && context.member(item)))));
-}