typedoc 0.28.0 → 0.28.2

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

@@ -1,14 +1,17 @@
 import { JSX } from "#utils";
 import {} from "../../../../models/index.js";
-import { getMemberSections } from "../../lib.js";
+import { getMemberSections, isNoneSection } from "../../lib.js";
 export function members(context, props) {
     const sections = getMemberSections(props, (child) => !context.router.hasOwnDocument(child));
-    return (JSX.createElement(JSX.Fragment, null, sections.map(({ title, children }) => {
-        context.page.startNewSection(title);
+    return (JSX.createElement(JSX.Fragment, null, sections.map((section) => {
+        if (isNoneSection(section)) {
+            return (JSX.createElement("section", { class: "tsd-panel-group tsd-member-group" }, section.children.map((item) => context.member(item))));
+        }
+        context.page.startNewSection(section.title);
         return (JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
-            JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + title },
+            JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + section.title },
                 context.icons.chevronDown(),
-                JSX.createElement("h2", null, title)),
-            JSX.createElement("section", null, children.map((item) => context.member(item)))));
+                JSX.createElement("h2", null, section.title)),
+            JSX.createElement("section", null, section.children.map((item) => context.member(item)))));
     })));
 }

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

@@ -1,6 +1,6 @@
 import { ReferenceReflection, ReflectionKind, } from "../../../../models/index.js";
 import { JSX } from "#utils";
-import { classNames, getDisplayName, getMemberSections, getUniquePath, join } from "../../lib.js";
+import { classNames, getDisplayName, getMemberSections, getUniquePath, isNoneSection, join } from "../../lib.js";
 import { anchorIcon } from "./anchor-icon.js";
 export function moduleReflection(context, mod) {
     const sections = getMemberSections(mod);
@@ -10,15 +10,22 @@ export function moduleReflection(context, mod) {
             context.commentTags(mod))),
         mod.isDeclaration() && mod.kind === ReflectionKind.Module && mod.readme?.length && (JSX.createElement("section", { class: "tsd-panel tsd-typography" },
             JSX.createElement(JSX.Raw, { html: context.markdown(mod.readme) }))),
-        sections.map(({ title, children, description }) => {
-            context.page.startNewSection(title);
+        sections.map((section) => {
+            if (!isNoneSection(section)) {
+                context.page.startNewSection(section.title);
+            }
+            const content = (JSX.createElement(JSX.Fragment, null,
+                section.description && (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
+                    JSX.createElement(JSX.Raw, { html: context.markdown(section.description) }))),
+                JSX.createElement("dl", { class: "tsd-member-summaries" }, section.children.map((item) => context.moduleMemberSummary(item)))));
+            if (isNoneSection(section)) {
+                return (JSX.createElement("section", { class: "tsd-panel-group tsd-member-group" }, content));
+            }
             return (JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
-                JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + title },
+                JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + section.title },
                     context.icons.chevronDown(),
-                    JSX.createElement("h2", null, title)),
-                description && (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
-                    JSX.createElement(JSX.Raw, { html: context.markdown(description) }))),
-                JSX.createElement("dl", { class: "tsd-member-summaries" }, children.map((item) => context.moduleMemberSummary(item)))));
+                    JSX.createElement("h2", null, section.title)),
+                content));
         })));
 }
 export function moduleMemberSummary(context, member) {

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

@@ -87,12 +87,20 @@ function buildSectionNavigation(context, headings) {
         const built = (JSX.createElement("ul", null, level.map((l) => JSX.createElement("li", null, l))));
         levels[levels.length - 1].push(built);
     }
+    function getInferredHeadingLevel(heading) {
+        if (heading.level) {
+            // Regular heading
+            return heading.level + 2;
+        }
+        if (heading.kind) {
+            // Reflection
+            return 2;
+        }
+        // Group/category
+        return 1;
+    }
     for (const heading of headings) {
-        const inferredLevel = heading.level
-            ? heading.level + 2 // regular heading
-            : heading.kind
-                ? 2 // reflection
-                : 1; // group/category
+        const inferredLevel = getInferredHeadingLevel(heading);
         while (inferredLevel < levels.length) {
             finalizeLevel(false);
         }

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

@@ -25,12 +25,13 @@ export declare function renderTypeParametersSignature(context: DefaultThemeRende
  */
 export declare function renderName(refl: Reflection): JSX.Element | (string | JSX.Element)[];
 export declare function getHierarchyRoots(project: ProjectReflection): DeclarationReflection[];
-export interface MemberSections {
+export declare function isNoneSection(section: MemberSection): boolean;
+export interface MemberSection {
     title: string;
     description?: CommentDisplayPart[];
     children: Array<DocumentReflection | DeclarationReflection>;
 }
-export declare function getMemberSections(parent: ContainerReflection, childFilter?: (refl: Reflection) => boolean): MemberSections[];
+export declare function getMemberSections(parent: ContainerReflection, childFilter?: (refl: Reflection) => boolean): MemberSection[];
 /**
  * Returns a (hopefully) globally unique path for the given reflection.
  *

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

@@ -70,17 +70,6 @@ export function hasTypeParameters(reflection) {
 export function renderTypeParametersSignature(context, typeParameters) {
     if (!typeParameters || typeParameters.length === 0)
         return JSX.createElement(JSX.Fragment, null);
-    const hideParamTypes = false; // context.options.getValue("hideTypesInSignatureTitle");
-    if (hideParamTypes) {
-        return (JSX.createElement(JSX.Fragment, null,
-            JSX.createElement("span", { class: "tsd-signature-symbol" }, "<"),
-            join(JSX.createElement("span", { class: "tsd-signature-symbol" }, ", "), typeParameters, (item) => (JSX.createElement(JSX.Fragment, null,
-                (item.flags.isConst || item.varianceModifier) && (JSX.createElement("span", { class: "tsd-signature-keyword" },
-                    item.flags.isConst && "const ",
-                    item.varianceModifier && `${item.varianceModifier} `)),
-                JSX.createElement("a", { class: "tsd-signature-type tsd-kind-type-parameter", href: context.urlTo(item) }, item.name)))),
-            JSX.createElement("span", { class: "tsd-signature-symbol" }, ">")));
-    }
     return (JSX.createElement(JSX.Fragment, null,
         JSX.createElement("span", { class: "tsd-signature-symbol" }, "<"),
         join(JSX.createElement("span", { class: "tsd-signature-symbol" }, ", "), typeParameters, (item) => (JSX.createElement(JSX.Fragment, null,
@@ -135,6 +124,18 @@ export function getHierarchyRoots(project) {
     rootsCache.set(project, result);
     return result;
 }
+export function isNoneSection(section) {
+    return section.title.toLocaleLowerCase() === "none";
+}
+function sortNoneSectionFirst(a, b) {
+    if (isNoneSection(a)) {
+        return -1;
+    }
+    if (isNoneSection(b)) {
+        return 1;
+    }
+    return 0;
+}
 export function getMemberSections(parent, childFilter = () => true) {
     if (parent.categories?.length) {
         return filterMap(parent.categories, (cat) => {
@@ -146,17 +147,17 @@ export function getMemberSections(parent, childFilter = () => true) {
                 description: cat.description,
                 children,
             };
-        });
+        }).sort(sortNoneSectionFirst);
     }
     if (parent.groups?.length) {
         return parent.groups.flatMap((group) => {
             if (group.categories?.length) {
-                return filterMap(group.categories, (cat) => {
+                return filterMap(group.categories.slice().sort(sortNoneSectionFirst), (cat) => {
                     const children = cat.children.filter(childFilter);
                     if (!children.length)
                         return;
                     return {
-                        title: `${group.title} - ${cat.title}`,
+                        title: isNoneSection(cat) ? group.title : `${group.title} - ${cat.title}`,
                         description: cat.description,
                         children,
                     };
@@ -170,7 +171,13 @@ export function getMemberSections(parent, childFilter = () => true) {
                 description: group.description,
                 children,
             };
-        });
+        }).sort(sortNoneSectionFirst);
+    }
+    if (parent.children?.length) {
+        return [{
+                title: "none",
+                children: parent.children || [],
+            }];
     }
     return [];
 }

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

@@ -12,7 +12,7 @@ export interface Deserializable<T> {
 /**
  * Deserializes TypeDoc's JSON output back to {@link Reflection} instances.
  *
- * @group Common
+ * @group None
  * @summary Deserializes TypeDoc's JSON output
  */
 export declare class Deserializer {

package/dist/lib/serialization/deserializer.js

@@ -5,7 +5,7 @@ const supportedSchemaVersions = [JSONOutput.SCHEMA_VERSION];
 /**
  * Deserializes TypeDoc's JSON output back to {@link Reflection} instances.
  *
- * @group Common
+ * @group None
  * @summary Deserializes TypeDoc's JSON output
  */
 export class Deserializer {

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

@@ -10,7 +10,7 @@ export interface SerializerEvents {
 /**
  * Serializes TypeDoc's models to JSON
  *
- * @group Common
+ * @group None
  * @summary Serializes TypeDoc's models to JSON
  */
 export declare class Serializer extends EventDispatcher<SerializerEvents> {

package/dist/lib/serialization/serializer.js

@@ -3,7 +3,7 @@ import { EventDispatcher, insertPrioritySorted, removeIfPresent } from "#utils";
 /**
  * Serializes TypeDoc's models to JSON
  *
- * @group Common
+ * @group None
  * @summary Serializes TypeDoc's models to JSON
  */
 export class Serializer extends EventDispatcher {

package/dist/lib/utils/entry-point.d.ts

@@ -36,7 +36,7 @@ export interface DocumentEntryPoint {
     displayName: string;
     path: NormalizedPath;
 }
-export declare function inferEntryPoints(logger: Logger, options: Options): DocumentationEntryPoint[];
+export declare function inferEntryPoints(logger: Logger, options: Options, programs?: ts.Program[]): DocumentationEntryPoint[];
 export declare function getEntryPoints(logger: Logger, options: Options): DocumentationEntryPoint[] | undefined;
 /**
  * Document entry points are markdown documents that the user has requested we include in the project with

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

@@ -30,7 +30,7 @@ export const EntryPointStrategy = {
      */
     Merge: "merge",
 };
-export function inferEntryPoints(logger, options) {
+export function inferEntryPoints(logger, options, programs) {
     const packageJson = discoverPackageJson(options.packageDir ?? process.cwd());
     if (!packageJson) {
         logger.warn(i18n.no_entry_points_provided());
@@ -38,7 +38,7 @@ export function inferEntryPoints(logger, options) {
     }
     const pathEntries = inferPackageEntryPointPaths(packageJson.file);
     const entryPoints = [];
-    const programs = getEntryPrograms(pathEntries.map((p) => p[1]), logger, options);
+    programs ||= getEntryPrograms(pathEntries.map((p) => p[1]), logger, options);
     // See also: addInferredDeclarationMapPaths in ReflectionSymbolId
     const jsToTsSource = new Map();
     for (const program of programs) {
@@ -137,10 +137,20 @@ export function getWatchEntryPoints(logger, options, program) {
     const strategy = options.getValue("entryPointStrategy");
     switch (strategy) {
         case EntryPointStrategy.Resolve:
-            result = getEntryPointsForPaths(logger, expandGlobs(entryPoints, exclude, logger), options, [program]);
+            if (options.isSet("entryPoints")) {
+                result = getEntryPointsForPaths(logger, expandGlobs(entryPoints, exclude, logger), options, [program]);
+            }
+            else {
+                result = inferEntryPoints(logger, options, [program]);
+            }
             break;
         case EntryPointStrategy.Expand:
-            result = getExpandedEntryPointsForPaths(logger, expandGlobs(entryPoints, exclude, logger), options, [program]);
+            if (options.isSet("entryPoints")) {
+                result = getExpandedEntryPointsForPaths(logger, expandGlobs(entryPoints, exclude, logger), options, [program]);
+            }
+            else {
+                result = inferEntryPoints(logger, options, [program]);
+            }
             break;
         case EntryPointStrategy.Packages:
             logger.error(i18n.watch_does_not_support_packages_mode());
@@ -218,16 +228,18 @@ function expandGlobs(globs, exclude, logger) {
         });
         const filtered = result.filter((file) => file === entry || !excludePatterns.matchesAny(file));
         if (result.length === 0) {
-            logger.warn(i18n.glob_0_did_not_match_any_files(nicePath(entry)));
+            // #2918 - do not pass entry through nicePath here in case it contains
+            // windows path separators which should cause additional warnings.
+            logger.warn(i18n.glob_0_did_not_match_any_files(entry));
             if (entry.includes("\\") && !entry.includes("/")) {
                 logger.info(i18n.glob_should_use_posix_slash());
             }
         }
         else if (filtered.length === 0) {
-            logger.warn(i18n.entry_point_0_did_not_match_any_files_after_exclude(nicePath(entry)));
+            logger.warn(i18n.entry_point_0_did_not_match_any_files_after_exclude(entry));
         }
         else if (filtered.length !== 1) {
-            logger.verbose(`Expanded ${nicePath(entry)} to:\n\t${filtered
+            logger.verbose(`Expanded ${entry} to:\n\t${filtered
                 .map(nicePath)
                 .join("\n\t")}`);
         }

package/dist/lib/utils/html.js

@@ -52,7 +52,7 @@ export function createNormalizedUrl(url) {
         }
         codePoints[i] = Chars.UNDERSCORE;
     }
-    return String.fromCharCode(...codePoints);
+    return String.fromCodePoint(...codePoints);
 }
 var Chars;
 (function (Chars) {

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

@@ -26,7 +26,7 @@ export type CommentStyle = (typeof CommentStyle)[keyof typeof CommentStyle];
 export type OutputSpecification = {
     name: string;
     path: string;
-    options?: Partial<TypeDocOptions>;
+    options?: TypeDocOptions;
 };
 /**
  * List of option names which, with `entryPointStrategy` set to `packages`
@@ -40,12 +40,13 @@ export declare const rootPackageOptions: readonly ["plugin", "packageOptions", "
  * @interface
  */
 export type TypeDocOptions = {
-    [K in keyof TypeDocOptionMap]: unknown extends TypeDocOptionMap[K] ? unknown : TypeDocOptionMap[K] extends ManuallyValidatedOption<infer ManuallyValidated> ? ManuallyValidated : TypeDocOptionMap[K] extends NormalizedPath[] | NormalizedPathOrModule[] | GlobString[] ? string[] : TypeDocOptionMap[K] extends NormalizedPath ? string : TypeDocOptionMap[K] extends string | string[] | number | boolean ? TypeDocOptionMap[K] : TypeDocOptionMap[K] extends Record<string, boolean> ? Partial<TypeDocOptionMap[K]> | boolean : keyof TypeDocOptionMap[K] | TypeDocOptionMap[K][keyof TypeDocOptionMap[K]];
+    [K in keyof TypeDocOptionMap]?: unknown extends TypeDocOptionMap[K] ? unknown : TypeDocOptionMap[K] extends ManuallyValidatedOption<infer ManuallyValidated> ? ManuallyValidated : TypeDocOptionMap[K] extends NormalizedPath[] | NormalizedPathOrModule[] | GlobString[] ? string[] : TypeDocOptionMap[K] extends NormalizedPath ? string : TypeDocOptionMap[K] extends string | string[] | number | boolean ? TypeDocOptionMap[K] : TypeDocOptionMap[K] extends Record<string, boolean> ? Partial<TypeDocOptionMap[K]> | boolean : keyof TypeDocOptionMap[K] | TypeDocOptionMap[K][keyof TypeDocOptionMap[K]];
 };
 /**
  * Describes all TypeDoc specific options as returned by {@link Options.getValue}, this is
  * slightly more restrictive than the {@link TypeDocOptions} since it does not allow both
  * keys and values for mapped option types, and does not allow partials of flag values.
+ * It also does not mark keys as optional.
  * @interface
  */
 export type TypeDocOptionValues = {
@@ -80,7 +81,7 @@ export interface TypeDocOptionMap {
     plugin: NormalizedPathOrModule[];
     lang: string;
     locales: ManuallyValidatedOption<Record<string, Record<string, string>>>;
-    packageOptions: ManuallyValidatedOption<Partial<TypeDocPackageOptions>>;
+    packageOptions: ManuallyValidatedOption<TypeDocPackageOptions>;
     entryPoints: GlobString[];
     entryPointStrategy: typeof EntryPointStrategy;
     alwaysCreateEntryPointModule: boolean;

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

@@ -27,6 +27,7 @@ export const excludeTags = [
     "@satisfies",
     "@overload",
     "@inline",
+    "@inlineType",
 ];
 export const blockTags = TagDefaults.blockTags;
 export const inlineTags = TagDefaults.inlineTags;
@@ -41,6 +42,7 @@ export const notRenderedTags = [
     "@showGroups",
     "@hideCategories",
     "@hideGroups",
+    "@disableGroups",
     "@expand",
     "@preventExpand",
     "@expandType",

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

@@ -60,7 +60,7 @@ export interface OptionsReader {
  * 4. argv (300) - Read argv again since any options set there should override those set in config
  *    files.
  *
- * @group Common
+ * @group None
  * @summary Contains all of TypeDoc's option declarations & values
  */
 export declare class Options {
@@ -138,7 +138,7 @@ export declare class Options {
     /**
      * Gets all of the TypeDoc option values defined in this option container.
      */
-    getRawValues(): Readonly<Partial<TypeDocOptions>>;
+    getRawValues(): Readonly<Partial<TypeDocOptionValues>>;
     /**
      * Gets a value for the given option key, throwing if the option has not been declared.
      * @param name
@@ -151,7 +151,7 @@ export declare class Options {
      * @param value
      * @param configPath the directory to resolve Path type values against
      */
-    setValue<K extends keyof TypeDocOptions>(name: K, value: TypeDocOptions[K], configPath?: string): void;
+    setValue<K extends keyof TypeDocOptions>(name: K, value: Exclude<TypeDocOptions[K], undefined>, configPath?: string): void;
     setValue(name: NeverIfInternal<string>, value: NeverIfInternal<unknown>, configPath?: NeverIfInternal<string>): void;
     /**
      * Gets the set compiler options.

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

@@ -26,7 +26,7 @@ const optionSnapshots = new WeakMap();
  * 4. argv (300) - Read argv again since any options set there should override those set in config
  *    files.
  *
- * @group Common
+ * @group None
  * @summary Contains all of TypeDoc's option declarations & values
  */
 export class Options {

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

@@ -3,4 +3,4 @@ export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@exam
 export declare const tsdocInlineTags: readonly ["@link", "@inheritDoc", "@label"];
 export declare const inlineTags: readonly ["@link", "@inheritDoc", "@label", "@linkcode", "@linkplain", "@include", "@includeCode"];
 export declare const tsdocModifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual"];
-export declare const modifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual", "@abstract", "@class", "@enum", "@event", "@expand", "@hidden", "@hideCategories", "@hideconstructor", "@hideGroups", "@ignore", "@inline", "@interface", "@namespace", "@function", "@overload", "@private", "@protected", "@showCategories", "@showGroups", "@useDeclaredType", "@primaryExport"];
+export declare const modifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual", "@abstract", "@class", "@disableGroups", "@enum", "@event", "@expand", "@hidden", "@hideCategories", "@hideconstructor", "@hideGroups", "@ignore", "@inline", "@interface", "@namespace", "@function", "@overload", "@private", "@protected", "@showCategories", "@showGroups", "@useDeclaredType", "@primaryExport"];

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

@@ -69,6 +69,7 @@ export const modifierTags = [
     ...tsdocModifierTags,
     "@abstract",
     "@class",
+    "@disableGroups",
     "@enum",
     "@event",
     "@expand",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.28.0",
+  "version": "0.28.2",
   "homepage": "https://typedoc.org",
   "type": "module",
   "exports": {
@@ -31,32 +31,32 @@
     "pnpm": ">= 10"
   },
   "dependencies": {
-    "@gerrit0/mini-shiki": "^3.2.1",
+    "@gerrit0/mini-shiki": "^3.2.2",
     "lunr": "^2.3.9",
     "markdown-it": "^14.1.0",
     "minimatch": "^9.0.5",
-    "yaml": "^2.7.0 "
+    "yaml": "^2.7.1"
   },
   "peerDependencies": {
     "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x"
   },
   "devDependencies": {
-    "@eslint/js": "^9.22.0",
+    "@eslint/js": "^9.24.0",
     "@types/lunr": "^2.3.7",
     "@types/markdown-it": "^14.1.2",
     "@types/mocha": "^10.0.10",
     "@types/node": "18",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#34113409e3a171e68ce5e2b55461ef5c35591cfe",
     "c8": "^10.1.3",
-    "dprint": "^0.49.0",
-    "esbuild": "^0.25.1",
-    "eslint": "^9.22.0",
+    "dprint": "^0.49.1",
+    "esbuild": "^0.25.2",
+    "eslint": "^9.24.0",
     "mocha": "^11.1.0",
-    "puppeteer": "^24.4.0",
+    "puppeteer": "^24.6.0",
     "semver": "^7.7.1",
     "tsx": "^4.19.3",
-    "typescript": "5.8.2",
-    "typescript-eslint": "^8.26.1"
+    "typescript": "5.8.3",
+    "typescript-eslint": "^8.29.0"
   },
   "files": [
     "/bin",