typedoc 0.25.13 → 0.26.0-beta.1

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

@@ -32,7 +32,7 @@ import type * as M from "../models";
  * Describes the mapping from Model types to the corresponding JSON output type.
  */
 export type ModelToObject<T> = T extends Array<infer U> ? _ModelToObject<U>[] : _ModelToObject<T>;
-type _ModelToObject<T> = T extends Primitive ? T : Required<T> extends Required<M.ReflectionGroup> ? ReflectionGroup : Required<T> extends Required<M.ReflectionCategory> ? ReflectionCategory : T extends M.SignatureReflection ? SignatureReflection : T extends M.ParameterReflection ? ParameterReflection : T extends M.DeclarationReflection ? DeclarationReflection : T extends M.TypeParameterReflection ? TypeParameterReflection : T extends M.ProjectReflection ? ProjectReflection : T extends M.ContainerReflection ? ContainerReflection : T extends M.ReferenceReflection ? ReferenceReflection : T extends M.Reflection ? Reflection : T extends M.SomeType ? TypeKindMap[T["type"]] : T extends M.Type ? SomeType : T extends M.Comment ? Comment : T extends M.CommentTag ? CommentTag : T extends M.CommentDisplayPart ? CommentDisplayPart : T extends M.SourceReference ? SourceReference : never;
+type _ModelToObject<T> = T extends Primitive ? T : Required<T> extends Required<M.ReflectionGroup> ? ReflectionGroup : Required<T> extends Required<M.ReflectionCategory> ? ReflectionCategory : T extends M.SignatureReflection ? SignatureReflection : T extends M.ParameterReflection ? ParameterReflection : T extends M.DeclarationReflection ? DeclarationReflection : T extends M.DocumentReflection ? DocumentReflection : T extends M.TypeParameterReflection ? TypeParameterReflection : T extends M.ProjectReflection ? ProjectReflection : T extends M.ContainerReflection ? ContainerReflection : T extends M.ReferenceReflection ? ReferenceReflection : T extends M.Reflection ? Reflection : T extends M.SomeType ? TypeKindMap[T["type"]] : T extends M.Type ? SomeType : T extends M.Comment ? Comment : T extends M.CommentTag ? CommentTag : T extends M.CommentDisplayPart ? CommentDisplayPart : T extends M.SourceReference ? SourceReference : never;
 type Primitive = string | number | undefined | null | boolean;
 type ToSerialized<T> = T extends Primitive ? T : T extends bigint ? {
     value: string;
@@ -62,6 +62,10 @@ export type SomeReflection = {
     [K in keyof M.ReflectionVariant]: ModelToObject<M.ReflectionVariant[K]>;
 }[keyof M.ReflectionVariant];
 /** @category Reflections */
+export interface DocumentReflection extends Omit<Reflection, "variant">, S<M.DocumentReflection, "variant" | "content" | "relevanceBoost"> {
+    frontmatter: Record<string, unknown>;
+}
+/** @category Reflections */
 export interface ReferenceReflection extends Omit<DeclarationReflection, "variant">, S<M.ReferenceReflection, "variant"> {
     /**
      * -1 if the reference refers to a symbol that does not exist in the documentation.
@@ -78,7 +82,9 @@ export interface ParameterReflection extends Omit<Reflection, "variant">, S<M.Pa
     variant: "param";
 }
 /** @category Reflections */
-export interface DeclarationReflection extends Omit<ContainerReflection, "variant">, S<M.DeclarationReflection, "variant" | "packageVersion" | "sources" | "relevanceBoost" | "type" | "signatures" | "indexSignature" | "defaultValue" | "overwrites" | "inheritedFrom" | "implementationOf" | "extendedTypes" | "extendedBy" | "implementedTypes" | "implementedBy" | "getSignature" | "setSignature" | "typeParameters" | "readme"> {
+export interface DeclarationReflection extends Omit<ContainerReflection, "variant">, S<M.DeclarationReflection, "variant" | "packageVersion" | "sources" | "relevanceBoost" | "type" | "signatures" | "indexSignatures" | "defaultValue" | "overwrites" | "inheritedFrom" | "implementationOf" | "extendedTypes" | "extendedBy" | "implementedTypes" | "implementedBy" | "getSignature" | "setSignature" | "typeParameters" | "readme"> {
+    /** @deprecated moved to {@link indexSignatures} with 0.26. */
+    indexSignature?: SignatureReflection;
 }
 /** @category Reflections */
 export interface TypeParameterReflection extends Omit<Reflection, "variant">, S<M.TypeParameterReflection, "variant" | "type" | "default" | "varianceModifier"> {
@@ -88,7 +94,8 @@ export interface ProjectReflection extends Omit<ContainerReflection, "variant">,
     symbolIdMap: Record<number, ReflectionSymbolId>;
 }
 /** @category Reflections */
-export interface ContainerReflection extends Reflection, S<M.ContainerReflection, "children" | "groups" | "categories"> {
+export interface ContainerReflection extends Reflection, S<M.ContainerReflection, "children" | "documents" | "groups" | "categories"> {
+    childrenIncludingDocuments?: number[];
 }
 /** @category Reflections */
 export interface Reflection extends S<M.Reflection, "id" | "variant" | "name" | "kind" | "comment"> {

package/dist/lib/utils/array.js

@@ -1,6 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterMap = exports.zip = exports.partition = exports.unique = exports.removeIf = exports.removeIfPresent = exports.binaryFindPartition = exports.insertOrderSorted = exports.insertPrioritySorted = void 0;
+exports.insertPrioritySorted = insertPrioritySorted;
+exports.insertOrderSorted = insertOrderSorted;
+exports.binaryFindPartition = binaryFindPartition;
+exports.removeIfPresent = removeIfPresent;
+exports.removeIf = removeIf;
+exports.unique = unique;
+exports.partition = partition;
+exports.zip = zip;
+exports.filterMap = filterMap;
 /**
  * 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.
@@ -12,7 +20,6 @@ function insertPrioritySorted(arr, item) {
     arr.splice(index === -1 ? arr.length : index, 0, item);
     return arr;
 }
-exports.insertPrioritySorted = insertPrioritySorted;
 /**
  * Inserts an item into an array sorted by order. If two items have the same order,
  * the item inserted later will be placed later in the array.
@@ -25,7 +32,6 @@ function insertOrderSorted(arr, item) {
     arr.splice(index === -1 ? arr.length : index, 0, item);
     return arr;
 }
-exports.insertOrderSorted = insertOrderSorted;
 /**
  * Performs a binary search of a given array, returning the index of the first item
  * for which `partition` returns true. Returns the -1 if there are no items in `arr`
@@ -49,7 +55,6 @@ function binaryFindPartition(arr, partition) {
     }
     return partition(arr[low]) ? low : -1;
 }
-exports.binaryFindPartition = binaryFindPartition;
 /**
  * Removes an item from the array if the array exists and the item is included
  * within it.
@@ -65,7 +70,6 @@ function removeIfPresent(arr, item) {
         arr.splice(index, 1);
     }
 }
-exports.removeIfPresent = removeIfPresent;
 /**
  * Remove items in an array which match a predicate.
  * @param arr
@@ -79,7 +83,6 @@ function removeIf(arr, predicate) {
         }
     }
 }
-exports.removeIf = removeIf;
 /**
  * Filters out duplicate values from the given iterable.
  * @param arr
@@ -87,7 +90,6 @@ exports.removeIf = removeIf;
 function unique(arr) {
     return Array.from(new Set(arr));
 }
-exports.unique = unique;
 function partition(iter, predicate) {
     const left = [];
     const right = [];
@@ -101,7 +103,6 @@ function partition(iter, predicate) {
     }
     return [left, right];
 }
-exports.partition = partition;
 function* zip(...args) {
     const iterators = args.map((x) => x[Symbol.iterator]());
     while (true) {
@@ -112,7 +113,6 @@ function* zip(...args) {
         yield next.map((v) => v.value);
     }
 }
-exports.zip = zip;
 function filterMap(iter, fn) {
     const result = [];
     for (const item of iter) {
@@ -123,4 +123,3 @@ function filterMap(iter, fn) {
     }
     return result;
 }
-exports.filterMap = filterMap;

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

@@ -1,5 +1,5 @@
 import type { Application } from "../application";
-import { EventDispatcher, Event, EventMap } from "./events";
+import { EventDispatcher, Event, type EventMap } from "./events";
 /**
  * Exposes a reference to the root Application component.
  */

package/dist/lib/utils/component.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChildableComponent = exports.AbstractComponent = exports.ComponentEvent = exports.Component = void 0;
+exports.ChildableComponent = exports.AbstractComponent = exports.ComponentEvent = void 0;
+exports.Component = Component;
 const events_1 = require("./events");
 const childMappings = [];
 /**
@@ -43,7 +44,6 @@ function Component(options) {
         }
     };
 }
-exports.Component = Component;
 class ComponentEvent extends events_1.Event {
     constructor(name, owner, component) {
         super(name);

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

@@ -34,7 +34,18 @@ export interface DocumentationEntryPoint {
     sourceFile: ts.SourceFile;
     version?: string;
 }
+export interface DocumentEntryPoint {
+    displayName: string;
+    path: string;
+}
 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
+ * an option rather than a `@document` tag.
+ *
+ * @returns A list of `.md` files to include in the documentation as documents.
+ */
+export declare function getDocumentEntryPoints(logger: Logger, options: Options): DocumentEntryPoint[];
 export declare function getWatchEntryPoints(logger: Logger, options: Options, program: ts.Program): DocumentationEntryPoint[] | undefined;
 export declare function getPackageDirectories(logger: Logger, options: Options, packageGlobPaths: string[]): string[];
 export declare function getExpandedEntryPointsForPaths(logger: Logger, inputFiles: string[], options: Options, programs?: ts.Program[]): DocumentationEntryPoint[];

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

@@ -26,7 +26,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExpandedEntryPointsForPaths = exports.getPackageDirectories = exports.getWatchEntryPoints = exports.getEntryPoints = exports.EntryPointStrategy = void 0;
+exports.EntryPointStrategy = void 0;
+exports.getEntryPoints = getEntryPoints;
+exports.getDocumentEntryPoints = getDocumentEntryPoints;
+exports.getWatchEntryPoints = getWatchEntryPoints;
+exports.getPackageDirectories = getPackageDirectories;
+exports.getExpandedEntryPointsForPaths = getExpandedEntryPointsForPaths;
 const path_1 = require("path");
 const typescript_1 = __importDefault(require("typescript"));
 const FS = __importStar(require("fs"));
@@ -61,7 +66,7 @@ exports.EntryPointStrategy = {
 };
 function getEntryPoints(logger, options) {
     if (!options.isSet("entryPoints")) {
-        logger.warn("No entry points were provided, this is likely a misconfiguration.");
+        logger.warn(logger.i18n.no_entry_points_provided());
         return [];
     }
     const entryPoints = options.getValue("entryPoints");
@@ -88,12 +93,35 @@ function getEntryPoints(logger, options) {
             (0, general_1.assertNever)(strategy);
     }
     if (result && result.length === 0) {
-        logger.error("Unable to find any entry points. See previous warnings.");
+        logger.error(logger.i18n.unable_to_find_any_entry_points());
         return;
     }
     return result;
 }
-exports.getEntryPoints = getEntryPoints;
+/**
+ * Document entry points are markdown documents that the user has requested we include in the project with
+ * an option rather than a `@document` tag.
+ *
+ * @returns A list of `.md` files to include in the documentation as documents.
+ */
+function getDocumentEntryPoints(logger, options) {
+    const docGlobs = options.getValue("projectDocuments");
+    if (docGlobs.length === 0) {
+        return [];
+    }
+    const docPaths = expandGlobs(docGlobs, [], logger);
+    // We might want to expand this in the future, there are quite a lot of extensions
+    // that have at some point or another been used for markdown: https://superuser.com/a/285878
+    const supportedFileRegex = /\.(md|markdown)$/;
+    const expanded = expandInputFiles(logger, docPaths, options, supportedFileRegex);
+    const baseDir = options.getValue("basePath") || (0, fs_1.deriveRootDir)(expanded);
+    return expanded.map((path) => {
+        return {
+            displayName: (0, path_1.relative)(baseDir, path).replace(/\.[^.]+$/, ""),
+            path,
+        };
+    });
+}
 function getWatchEntryPoints(logger, options, program) {
     let result;
     const entryPoints = options.getValue("entryPoints");
@@ -107,21 +135,20 @@ function getWatchEntryPoints(logger, options, program) {
             result = getExpandedEntryPointsForPaths(logger, expandGlobs(entryPoints, exclude, logger), options, [program]);
             break;
         case exports.EntryPointStrategy.Packages:
-            logger.error("Watch mode does not support 'packages' style entry points.");
+            logger.error(logger.i18n.watch_does_not_support_packages_mode());
             break;
         case exports.EntryPointStrategy.Merge:
-            logger.error("Watch mode does not support 'merge' style entry points.");
+            logger.error(logger.i18n.watch_does_not_support_merge_mode());
             break;
         default:
             (0, general_1.assertNever)(strategy);
     }
     if (result && result.length === 0) {
-        logger.error("Unable to find any entry points.");
+        logger.error(logger.i18n.unable_to_find_any_entry_points());
         return;
     }
     return result;
 }
-exports.getWatchEntryPoints = getWatchEntryPoints;
 function getPackageDirectories(logger, options, packageGlobPaths) {
     const exclude = (0, paths_1.createMinimatch)(options.getValue("exclude"));
     const rootDir = (0, fs_1.deriveRootDir)(packageGlobPaths);
@@ -129,7 +156,6 @@ function getPackageDirectories(logger, options, packageGlobPaths) {
     // This expands them to leave only leaf packages
     return (0, package_manifest_1.expandPackages)(logger, rootDir, packageGlobPaths, exclude);
 }
-exports.getPackageDirectories = getPackageDirectories;
 function getModuleName(fileName, baseDir) {
     return (0, paths_1.normalizePath)((0, path_1.relative)(baseDir, fileName)).replace(/(\/index)?(\.d)?\.([cm][tj]s|[tj]sx?)$/, "");
 }
@@ -140,6 +166,7 @@ function getModuleName(fileName, baseDir) {
 function getEntryPointsForPaths(logger, inputFiles, options, programs = getEntryPrograms(inputFiles, logger, options)) {
     const baseDir = options.getValue("basePath") || (0, fs_1.deriveRootDir)(inputFiles);
     const entryPoints = [];
+    let expandSuggestion = true;
     entryLoop: for (const fileOrDir of inputFiles.map(paths_1.normalizePath)) {
         const toCheck = [fileOrDir];
         if (!/\.([cm][tj]s|[tj]sx?)$/.test(fileOrDir)) {
@@ -158,17 +185,21 @@ function getEntryPointsForPaths(logger, inputFiles, options, programs = getEntry
                 }
             }
         }
-        const suggestion = (0, fs_1.isDir)(fileOrDir)
-            ? " If you wanted to include files inside this directory, set --entryPointStrategy to expand or specify a glob."
-            : "";
-        logger.warn(`The entry point ${(0, paths_1.nicePath)(fileOrDir)} is not referenced by the 'files' or 'include' option in your tsconfig.${suggestion}`);
+        logger.warn(logger.i18n.entry_point_0_not_in_program((0, paths_1.nicePath)(fileOrDir)));
+        if (expandSuggestion && (0, fs_1.isDir)(fileOrDir)) {
+            expandSuggestion = false;
+            logger.info(logger.i18n.use_expand_or_glob_for_files_in_dir());
+        }
     }
     return entryPoints;
 }
 function getExpandedEntryPointsForPaths(logger, inputFiles, options, programs = getEntryPrograms(inputFiles, logger, options)) {
-    return getEntryPointsForPaths(logger, expandInputFiles(logger, inputFiles, options), options, programs);
+    const compilerOptions = options.getCompilerOptions();
+    const supportedFileRegex = compilerOptions.allowJs || compilerOptions.checkJs
+        ? /\.([cm][tj]s|[tj]sx?)$/
+        : /\.([cm]ts|tsx?)$/;
+    return getEntryPointsForPaths(logger, expandInputFiles(logger, inputFiles, options, supportedFileRegex), options, programs);
 }
-exports.getExpandedEntryPointsForPaths = getExpandedEntryPointsForPaths;
 function expandGlobs(inputFiles, exclude, logger) {
     const excludePatterns = (0, paths_1.createMinimatch)(exclude);
     const base = (0, fs_1.deriveRootDir)(inputFiles);
@@ -179,10 +210,10 @@ function expandGlobs(inputFiles, exclude, logger) {
         });
         const filtered = result.filter((file) => file === entry || !(0, paths_1.matchesAny)(excludePatterns, file));
         if (result.length === 0) {
-            logger.warn(`The entrypoint glob ${(0, paths_1.nicePath)(entry)} did not match any files.`);
+            logger.warn(logger.i18n.glob_0_did_not_match_any_files((0, paths_1.nicePath)(entry)));
         }
         else if (filtered.length === 0) {
-            logger.warn(`The entrypoint glob ${(0, paths_1.nicePath)(entry)} did not match any files after applying exclude patterns.`);
+            logger.warn(logger.i18n.entry_point_0_did_not_match_any_files_after_exclude((0, paths_1.nicePath)(entry)));
         }
         else {
             logger.verbose(`Expanded ${(0, paths_1.nicePath)(entry)} to:\n\t${filtered
@@ -234,13 +265,9 @@ function getEntryPrograms(inputFiles, logger, options) {
  * @param inputFiles  The list of files that should be expanded.
  * @returns  The list of input files with expanded directories.
  */
-function expandInputFiles(logger, entryPoints, options) {
+function expandInputFiles(logger, entryPoints, options, supportedFile) {
     const files = [];
     const exclude = (0, paths_1.createMinimatch)(options.getValue("exclude"));
-    const compilerOptions = options.getCompilerOptions();
-    const supportedFileRegex = compilerOptions.allowJs || compilerOptions.checkJs
-        ? /\.([cm][tj]s|[tj]sx?)$/
-        : /\.([cm]ts|tsx?)$/;
     function add(file, entryPoint) {
         let stats;
         try {
@@ -259,7 +286,7 @@ function expandInputFiles(logger, entryPoints, options) {
                 add((0, path_1.join)(file, next), false);
             });
         }
-        else if (supportedFileRegex.test(file)) {
+        else if (supportedFile.test(file)) {
             if (!entryPoint && (0, paths_1.matchesAny)(exclude, file)) {
                 return;
             }
@@ -269,7 +296,7 @@ function expandInputFiles(logger, entryPoints, options) {
     entryPoints.forEach((file) => {
         const resolved = (0, path_1.resolve)(file);
         if (!FS.existsSync(resolved)) {
-            logger.warn(`Provided entry point ${file} does not exist and will not be included in the docs.`);
+            logger.warn(logger.i18n.entry_point_0_did_not_exist(file));
             return;
         }
         add(resolved, true);

package/dist/lib/utils/enum.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnumKeys = exports.debugFlags = exports.hasAnyFlag = exports.hasAllFlags = exports.removeFlag = exports.getEnumFlags = void 0;
+exports.getEnumFlags = getEnumFlags;
+exports.removeFlag = removeFlag;
+exports.hasAllFlags = hasAllFlags;
+exports.hasAnyFlag = hasAnyFlag;
+exports.debugFlags = debugFlags;
+exports.getEnumKeys = getEnumKeys;
 function getEnumFlags(flags) {
     const result = [];
     for (let i = 1; i <= flags; i <<= 1) {
@@ -10,27 +15,21 @@ function getEnumFlags(flags) {
     }
     return result;
 }
-exports.getEnumFlags = getEnumFlags;
 // T & {} reduces inference priority
 function removeFlag(flag, remove) {
     return (flag & ~remove);
 }
-exports.removeFlag = removeFlag;
 function hasAllFlags(flags, check) {
     return (flags & check) === check;
 }
-exports.hasAllFlags = hasAllFlags;
 function hasAnyFlag(flags, check) {
     return (flags & check) !== 0;
 }
-exports.hasAnyFlag = hasAnyFlag;
 function debugFlags(Enum, flags) {
     return getEnumKeys(Enum).filter((key) => (Enum[key] & flags) === Enum[key]);
 }
-exports.debugFlags = debugFlags;
 // Note: String enums are not handled.
 function getEnumKeys(Enum) {
     const E = Enum;
     return Object.keys(E).filter((k) => E[E[k]] === k);
 }
-exports.getEnumKeys = getEnumKeys;

package/dist/lib/utils/fs.js

@@ -23,7 +23,21 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findPackageForPath = exports.discoverPackageJson = exports.discoverInParentDirExactMatch = exports.discoverInParentDir = exports.hasTsExtension = exports.glob = exports.copySync = exports.copy = exports.writeFile = exports.writeFileSync = exports.readFile = exports.getCommonDirectory = exports.deriveRootDir = exports.isDir = exports.isFile = void 0;
+exports.isFile = isFile;
+exports.isDir = isDir;
+exports.deriveRootDir = deriveRootDir;
+exports.getCommonDirectory = getCommonDirectory;
+exports.readFile = readFile;
+exports.writeFileSync = writeFileSync;
+exports.writeFile = writeFile;
+exports.copy = copy;
+exports.copySync = copySync;
+exports.glob = glob;
+exports.hasTsExtension = hasTsExtension;
+exports.discoverInParentDir = discoverInParentDir;
+exports.discoverInParentDirExactMatch = discoverInParentDirExactMatch;
+exports.discoverPackageJson = discoverPackageJson;
+exports.findPackageForPath = findPackageForPath;
 const fs = __importStar(require("fs"));
 const fs_1 = require("fs");
 const minimatch_1 = require("minimatch");
@@ -39,7 +53,6 @@ function isFile(file) {
         return false;
     }
 }
-exports.isFile = isFile;
 function isDir(path) {
     try {
         return fs.statSync(path).isDirectory();
@@ -48,7 +61,6 @@ function isDir(path) {
         return false;
     }
 }
-exports.isDir = isDir;
 function deriveRootDir(globPaths) {
     const normalized = globPaths.map(paths_1.normalizePath);
     const globs = (0, paths_1.createMinimatch)(normalized);
@@ -64,7 +76,6 @@ function deriveRootDir(globPaths) {
     }));
     return getCommonDirectory(rootPaths);
 }
-exports.deriveRootDir = deriveRootDir;
 /**
  * Get the longest directory path common to all files.
  */
@@ -83,7 +94,6 @@ function getCommonDirectory(files) {
     }
     return roots[0].slice(0, i).join("/");
 }
-exports.getCommonDirectory = getCommonDirectory;
 /**
  * Load the given file and return its contents.
  *
@@ -117,7 +127,6 @@ function readFile(file) {
     }
     return buffer.toString("utf8", 0);
 }
-exports.readFile = readFile;
 /**
  * Write a file to disc.
  *
@@ -130,7 +139,6 @@ function writeFileSync(fileName, data) {
     fs.mkdirSync((0, path_1.dirname)((0, paths_1.normalizePath)(fileName)), { recursive: true });
     fs.writeFileSync((0, paths_1.normalizePath)(fileName), data);
 }
-exports.writeFileSync = writeFileSync;
 /**
  * Write a file to disc.
  *
@@ -145,7 +153,6 @@ async function writeFile(fileName, data) {
     });
     await fs_1.promises.writeFile((0, paths_1.normalizePath)(fileName), data);
 }
-exports.writeFile = writeFile;
 /**
  * Copy a file or directory recursively.
  */
@@ -163,7 +170,6 @@ async function copy(src, dest) {
         // Do nothing for FIFO, special devices.
     }
 }
-exports.copy = copy;
 function copySync(src, dest) {
     const stat = fs.statSync(src);
     if (stat.isDirectory()) {
@@ -178,7 +184,6 @@ function copySync(src, dest) {
         // Do nothing for FIFO, special devices.
     }
 }
-exports.copySync = copySync;
 /**
  * Simpler version of `glob.sync` that only covers our use cases, always ignoring node_modules.
  */
@@ -269,11 +274,9 @@ function glob(pattern, root, options = {}) {
     }
     return result;
 }
-exports.glob = glob;
 function hasTsExtension(path) {
     return /\.[cm]?ts$|\.tsx$/.test(path);
 }
-exports.hasTsExtension = hasTsExtension;
 function discoverInParentDir(name, dir, read) {
     if (!isDir(dir))
         return;
@@ -295,7 +298,6 @@ function discoverInParentDir(name, dir, read) {
         dir = (0, path_1.resolve)((0, path_1.join)(dir, ".."));
     }
 }
-exports.discoverInParentDir = discoverInParentDir;
 function discoverInParentDirExactMatch(name, dir, read) {
     if (!isDir(dir))
         return;
@@ -313,7 +315,6 @@ function discoverInParentDirExactMatch(name, dir, read) {
         dir = (0, path_1.resolve)((0, path_1.join)(dir, ".."));
     }
 }
-exports.discoverInParentDirExactMatch = discoverInParentDirExactMatch;
 function discoverPackageJson(dir) {
     return discoverInParentDirExactMatch("package.json", dir, (content) => {
         const pkg = JSON.parse(content);
@@ -322,7 +323,6 @@ function discoverPackageJson(dir) {
         }
     });
 }
-exports.discoverPackageJson = discoverPackageJson;
 // dir -> package name according to package.json in this or some parent dir
 const packageCache = new Map();
 function findPackageForPath(sourcePath) {
@@ -337,4 +337,3 @@ function findPackageForPath(sourcePath) {
         return packageJson.content.name;
     }
 }
-exports.findPackageForPath = findPackageForPath;

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

@@ -6,7 +6,7 @@
  */
 type InternalOnly = false;
 /**
- * Helper type to convert `T` to `F` if strict mode is on.
+ * Helper type to convert `T` to `F` if compiling TypeDoc with stricter types.
  *
  * Can be used in overloads to map a parameter type to `never`. For example, the
  * following function will work with any string argument, but to improve the type safety
@@ -19,13 +19,14 @@ type InternalOnly = false;
  *
  * ```ts
  * function over(flag: 'a' | 'b'): string
- * function over(flag: IfStrict<string, never>): string
+ * // deprecated
+ * function over(flag: IfInternal<never, string>): string
  * function over(flag: string): string { return flag }
  * ```
  */
 export type IfInternal<T, F> = InternalOnly extends true ? T : F;
 /**
- * Helper type to convert `T` to `never` if strict mode is on.
+ * Helper type to convert `T` to `never` if compiling TypeDoc with stricter types.
  *
  * See {@link IfInternal} for the rationale.
  */

package/dist/lib/utils/general.js

@@ -23,7 +23,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLoadedPaths = exports.hasBeenLoadedMultipleTimes = exports.NonEnumerable = exports.assertNever = void 0;
+exports.assertNever = assertNever;
+exports.NonEnumerable = NonEnumerable;
+exports.hasBeenLoadedMultipleTimes = hasBeenLoadedMultipleTimes;
+exports.getLoadedPaths = getLoadedPaths;
 const path_1 = require("path");
 const Util = __importStar(require("util"));
 /**
@@ -32,7 +35,6 @@ const Util = __importStar(require("util"));
 function assertNever(x) {
     throw new Error(`Expected handling to cover all possible cases, but it didn't cover: ${Util.inspect(x)}`);
 }
-exports.assertNever = assertNever;
 function NonEnumerable(_cls, context) {
     context.addInitializer(function () {
         Object.defineProperty(this, context.name, {
@@ -42,7 +44,6 @@ function NonEnumerable(_cls, context) {
         });
     });
 }
-exports.NonEnumerable = NonEnumerable;
 /**
  * This is a hack to make it possible to detect and warn about installation setups
  * which result in TypeDoc being installed multiple times. If TypeDoc has been loaded
@@ -58,8 +59,6 @@ g[pathSymbol].push((0, path_1.dirname)((0, path_1.dirname)((0, path_1.dirname)(_
 function hasBeenLoadedMultipleTimes() {
     return g[loadSymbol] !== 1;
 }
-exports.hasBeenLoadedMultipleTimes = hasBeenLoadedMultipleTimes;
 function getLoadedPaths() {
     return g[pathSymbol] || [];
 }
-exports.getLoadedPaths = getLoadedPaths;

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

@@ -1,6 +1,8 @@
-import { Theme } from "shiki";
-export declare function loadHighlighter(lightTheme: Theme, darkTheme: Theme): Promise<void>;
+import type { BundledTheme } from "shiki" with { "resolution-mode": "import" };
+export declare function loadShikiMetadata(): Promise<void>;
+export declare function loadHighlighter(lightTheme: BundledTheme, darkTheme: BundledTheme): Promise<void>;
 export declare function isSupportedLanguage(lang: string): boolean;
 export declare function getSupportedLanguages(): string[];
+export declare function getSupportedThemes(): string[];
 export declare function highlight(code: string, lang: string): string;
 export declare function getStyles(): string;