typedoc 0.23.11 → 0.23.12

package/dist/index.d.ts

@@ -7,7 +7,7 @@ export { Converter, Context, type CommentParserConfig } from "./lib/converter";
 export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
 export type { RenderTemplate, RendererHooks } from "./lib/output";
 export { ArgumentsReader, BindOption, CommentStyle, JSX, LogLevel, Logger, Options, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, } from "./lib/utils";
-export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, } from "./lib/utils";
+export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, } from "./lib/utils";
 export type { EventMap, EventCallback } from "./lib/utils/events";
 export { JSONOutput, Serializer, type SerializerComponent, SerializeEvent, } from "./lib/serialization";
 export type { SerializeEventData } from "./lib/serialization";

package/dist/lib/application-events.d.ts

@@ -0,0 +1,3 @@
+export declare const ApplicationEvents: {
+    BOOTSTRAP_END: string;
+};

package/dist/lib/application-events.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplicationEvents = void 0;
+exports.ApplicationEvents = {
+    BOOTSTRAP_END: "bootstrapEnd",
+};

package/dist/lib/application.d.ts

@@ -46,6 +46,12 @@ export declare class Application extends ChildableComponent<Application, Abstrac
      * The version number of TypeDoc.
      */
     static VERSION: string;
+    /**
+     * Emitted after plugins have been loaded and options have been read, but before they have been frozen.
+     * The listener will be given an instance of {@link Application} and the {@link TypeDocOptions | Partial<TypeDocOptions>}
+     * passed to `bootstrap`.
+     */
+    static readonly EVENT_BOOTSTRAP_END: string;
     /**
      * Create a new TypeDoc application instance.
      *

package/dist/lib/application.js

@@ -24,6 +24,7 @@ const general_1 = require("./utils/general");
 const exports_1 = require("./validation/exports");
 const documentation_1 = require("./validation/documentation");
 const links_1 = require("./validation/links");
+const application_events_1 = require("./application-events");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageInfo = require("../../package.json");
 const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
@@ -98,6 +99,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         if ((0, general_1.hasBeenLoadedMultipleTimes)()) {
             this.logger.warn(`TypeDoc has been loaded multiple times. This is commonly caused by plugins which have their own installation of TypeDoc. The loaded paths are:\n\t${(0, general_1.getLoadedPaths)().join("\n\t")}`);
         }
+        this.trigger(application_events_1.ApplicationEvents.BOOTSTRAP_END, this, options);
     }
     /**
      * Return the path to the TypeScript compiler.
@@ -304,6 +306,12 @@ let Application = Application_1 = class Application extends component_1.Childabl
  * The version number of TypeDoc.
  */
 Application.VERSION = packageInfo.version;
+/**
+ * Emitted after plugins have been loaded and options have been read, but before they have been frozen.
+ * The listener will be given an instance of {@link Application} and the {@link TypeDocOptions | Partial<TypeDocOptions>}
+ * passed to `bootstrap`.
+ */
+Application.EVENT_BOOTSTRAP_END = application_events_1.ApplicationEvents.BOOTSTRAP_END;
 __decorate([
     (0, utils_1.BindOption)("logger")
 ], Application.prototype, "loggerType", void 0);

package/dist/lib/converter/utils/nodes.js

@@ -4,9 +4,7 @@ exports.getHeritageTypes = exports.isNamedNode = void 0;
 const ts = require("typescript");
 function isNamedNode(node) {
     const name = node.name;
-    return (!!name &&
-        (ts.isIdentifierOrPrivateIdentifier(name) ||
-            ts.isComputedPropertyName(name)));
+    return !!name && (ts.isMemberName(name) || ts.isComputedPropertyName(name));
 }
 exports.isNamedNode = isNamedNode;
 function getHeritageTypes(declarations, kind) {

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

@@ -9,6 +9,7 @@ const package_manifest_1 = require("./package-manifest");
 const paths_1 = require("./paths");
 const fs_1 = require("./fs");
 const validation_1 = require("./validation");
+const array_1 = require("./array");
 /**
  * Defines how entry points are interpreted.
  * @enum
@@ -191,6 +192,14 @@ function expandInputFiles(logger, entryPoints, options) {
     });
     return files;
 }
+function deriveRootDir(packageGlobPaths) {
+    const globs = (0, paths_1.createMinimatch)(packageGlobPaths);
+    const rootPaths = globs.flatMap((glob) => (0, array_1.filterMap)(glob.set, (set) => {
+        const stop = set.findIndex((part) => typeof part !== "string");
+        return stop === -1 ? set.join("/") : set.slice(0, stop).join("/");
+    }));
+    return (0, fs_1.getCommonDirectory)(rootPaths);
+}
 /**
  * Expand the provided packages configuration paths, determining the entry points
  * and creating the ts.Programs for any which are found.
@@ -201,9 +210,10 @@ function expandInputFiles(logger, entryPoints, options) {
 function getEntryPointsForPackages(logger, packageGlobPaths, options) {
     const results = [];
     const exclude = (0, paths_1.createMinimatch)(options.getValue("exclude"));
+    const rootDir = deriveRootDir(packageGlobPaths);
     // packages arguments are workspace tree roots, or glob patterns
     // This expands them to leave only leaf packages
-    const expandedPackages = (0, package_manifest_1.expandPackages)(logger, ".", packageGlobPaths, exclude);
+    const expandedPackages = (0, package_manifest_1.expandPackages)(logger, rootDir, packageGlobPaths, exclude);
     for (const packagePath of expandedPackages) {
         const packageJsonPath = (0, path_1.resolve)(packagePath, "package.json");
         const packageJson = (0, package_manifest_1.loadPackageManifest)(logger, packageJsonPath);

package/dist/lib/utils/fs.js

@@ -149,10 +149,9 @@ function glob(pattern, root, options) {
             }
             if (child.isDirectory() && child.name !== "node_modules") {
                 const childPath = dir.concat(child.name);
-                if (mini.set.some((row) => mini.matchOne(
-                // @ts-expect-error childPath really should be an array of strings, not a string.
-                // https://github.com/DefinitelyTyped/DefinitelyTyped/pull/61956
-                childPath, row, 
+                if (mini.set.some((row) => mini.matchOne(childPath, 
+                // @ts-expect-error https://github.com/DefinitelyTyped/DefinitelyTyped/pull/62049
+                row, 
                 /* partial */ true))) {
                     dirs.push(childPath);
                 }

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

@@ -7,7 +7,7 @@ export { assertNever } from "./general";
 export { CallbackLogger, ConsoleLogger, Logger, LogLevel } from "./loggers";
 export { DefaultMap } from "./map";
 export { ArgumentsReader, BindOption, CommentStyle, Options, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, } from "./options";
-export type { ArrayDeclarationOption, BooleanDeclarationOption, DeclarationOption, DeclarationOptionBase, DeclarationOptionToOptionType, KeyToDeclaration, MapDeclarationOption, MixedDeclarationOption, NumberDeclarationOption, FlagsDeclarationOption, OptionsReader, StringDeclarationOption, TypeDocOptionMap, TypeDocOptions, ValidationOptions, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, } from "./options";
+export type { ArrayDeclarationOption, BooleanDeclarationOption, DeclarationOption, DeclarationOptionBase, DeclarationOptionToOptionType, KeyToDeclaration, MapDeclarationOption, MixedDeclarationOption, NumberDeclarationOption, FlagsDeclarationOption, ObjectDeclarationOption, OptionsReader, StringDeclarationOption, TypeDocOptionMap, TypeDocOptions, ValidationOptions, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, } from "./options";
 export { discoverPlugins, loadPlugins } from "./plugins";
 export { sortReflections } from "./sort";
 export type { SortStrategy } from "./sort";

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

@@ -137,9 +137,11 @@ export declare type ValidationOptions = {
 /**
  * Converts a given TypeDoc option key to the type of the declaration expected.
  */
-export declare type KeyToDeclaration<K extends keyof TypeDocOptionMap> = TypeDocOptionMap[K] extends boolean ? BooleanDeclarationOption : TypeDocOptionMap[K] extends string ? StringDeclarationOption : TypeDocOptionMap[K] extends number ? NumberDeclarationOption : TypeDocOptionMap[K] extends string[] ? ArrayDeclarationOption : unknown extends TypeDocOptionMap[K] ? MixedDeclarationOption : TypeDocOptionMap[K] extends ManuallyValidatedOption<unknown> ? MixedDeclarationOption & {
+export declare type KeyToDeclaration<K extends keyof TypeDocOptionMap> = TypeDocOptionMap[K] extends boolean ? BooleanDeclarationOption : TypeDocOptionMap[K] extends string ? StringDeclarationOption : TypeDocOptionMap[K] extends number ? NumberDeclarationOption : TypeDocOptionMap[K] extends string[] ? ArrayDeclarationOption : unknown extends TypeDocOptionMap[K] ? MixedDeclarationOption | ObjectDeclarationOption : TypeDocOptionMap[K] extends ManuallyValidatedOption<unknown> ? (MixedDeclarationOption & {
     validate(value: unknown): void;
-} : TypeDocOptionMap[K] extends Record<string, boolean> ? FlagsDeclarationOption<TypeDocOptionMap[K]> : TypeDocOptionMap[K] extends Record<string | number, infer U> ? MapDeclarationOption<U> : never;
+}) | (ObjectDeclarationOption & {
+    validate(value: unknown): void;
+}) : TypeDocOptionMap[K] extends Record<string, boolean> ? FlagsDeclarationOption<TypeDocOptionMap[K]> : TypeDocOptionMap[K] extends Record<string | number, infer U> ? MapDeclarationOption<U> : never;
 export declare enum ParameterHint {
     File = 0,
     Directory = 1
@@ -167,10 +169,14 @@ export declare enum ParameterType {
      * Resolved according to the config directory unless it starts with `**`, after skipping any leading `!` and `#` characters.
      */
     GlobArray = 9,
+    /**
+     * An unopinionated object that preserves default settings unless explicitly overridden
+     */
+    Object = 10,
     /**
      * An object with true/false flags
      */
-    Flags = 10
+    Flags = 11
 }
 export interface DeclarationOptionBase {
     /**
@@ -258,6 +264,18 @@ export interface MixedDeclarationOption extends DeclarationOptionBase {
      */
     validate?: (value: unknown) => void;
 }
+export interface ObjectDeclarationOption extends DeclarationOptionBase {
+    type: ParameterType.Object;
+    /**
+     * If not specified defaults to undefined.
+     */
+    defaultValue?: unknown;
+    /**
+     * An optional validation function that validates a potential value of this option.
+     * The function must throw an Error if the validation fails and should do nothing otherwise.
+     */
+    validate?: (value: unknown) => void;
+}
 export interface MapDeclarationOption<T> extends DeclarationOptionBase {
     type: ParameterType.Map;
     /**
@@ -283,13 +301,14 @@ export interface FlagsDeclarationOption<T extends Record<string, boolean>> exten
      */
     defaults: T;
 }
-export declare type DeclarationOption = StringDeclarationOption | NumberDeclarationOption | BooleanDeclarationOption | MixedDeclarationOption | MapDeclarationOption<unknown> | ArrayDeclarationOption | FlagsDeclarationOption<Record<string, boolean>>;
+export declare type DeclarationOption = StringDeclarationOption | NumberDeclarationOption | BooleanDeclarationOption | MixedDeclarationOption | ObjectDeclarationOption | MapDeclarationOption<unknown> | ArrayDeclarationOption | FlagsDeclarationOption<Record<string, boolean>>;
 export interface ParameterTypeToOptionTypeMap {
     [ParameterType.String]: string;
     [ParameterType.Path]: string;
     [ParameterType.Number]: number;
     [ParameterType.Boolean]: boolean;
     [ParameterType.Mixed]: unknown;
+    [ParameterType.Object]: unknown;
     [ParameterType.Array]: string[];
     [ParameterType.PathArray]: string[];
     [ParameterType.ModuleArray]: string[];
@@ -306,5 +325,5 @@ export declare type DeclarationOptionToOptionType<T extends DeclarationOption> =
  * @param option The option for which the value should be converted.
  * @returns The result of the conversion. Might be the value or an error.
  */
-export declare function convert(value: unknown, option: DeclarationOption, configPath: string): unknown;
+export declare function convert(value: unknown, option: DeclarationOption, configPath: string, oldValue?: unknown): unknown;
 export declare function getDefaultValue(option: DeclarationOption): unknown;

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

@@ -47,10 +47,14 @@ var ParameterType;
      * Resolved according to the config directory unless it starts with `**`, after skipping any leading `!` and `#` characters.
      */
     ParameterType[ParameterType["GlobArray"] = 9] = "GlobArray";
+    /**
+     * An unopinionated object that preserves default settings unless explicitly overridden
+     */
+    ParameterType[ParameterType["Object"] = 10] = "Object";
     /**
      * An object with true/false flags
      */
-    ParameterType[ParameterType["Flags"] = 10] = "Flags";
+    ParameterType[ParameterType["Flags"] = 11] = "Flags";
 })(ParameterType = exports.ParameterType || (exports.ParameterType = {}));
 const converters = {
     [ParameterType.String](value, option) {
@@ -146,6 +150,12 @@ const converters = {
         option.validate?.(value);
         return value;
     },
+    [ParameterType.Object](value, option, _configPath, oldValue) {
+        option.validate?.(value);
+        if (typeof oldValue !== "undefined")
+            value = { ...oldValue, ...value };
+        return value;
+    },
     [ParameterType.Flags](value, option) {
         if (typeof value === "boolean") {
             value = Object.fromEntries(Object.keys(option.defaults).map((key) => [key, value]));
@@ -179,9 +189,9 @@ const converters = {
  * @param option The option for which the value should be converted.
  * @returns The result of the conversion. Might be the value or an error.
  */
-function convert(value, option, configPath) {
+function convert(value, option, configPath, oldValue) {
     const _converters = converters;
-    return _converters[option.type ?? ParameterType.String](value, option, configPath);
+    return _converters[option.type ?? ParameterType.String](value, option, configPath, oldValue);
 }
 exports.convert = convert;
 const defaultGetters = {
@@ -209,6 +219,9 @@ const defaultGetters = {
     [ParameterType.Mixed](option) {
         return option.defaultValue;
     },
+    [ParameterType.Object](option) {
+        return option.defaultValue;
+    },
     [ParameterType.Array](option) {
         return option.defaultValue?.slice() ?? [];
     },

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

@@ -2,4 +2,4 @@ export { Options, BindOption } from "./options";
 export type { OptionsReader } from "./options";
 export { ArgumentsReader, TypeDocReader, TSConfigReader } from "./readers";
 export { CommentStyle, EmitStrategy, ParameterType, ParameterHint, } from "./declaration";
-export type { TypeDocOptions, TypeDocOptionMap, ValidationOptions, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, } from "./declaration";
+export type { TypeDocOptions, TypeDocOptionMap, ValidationOptions, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, } from "./declaration";

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

@@ -164,7 +164,10 @@ class Options {
         if (!declaration) {
             throw new Error(`Tried to set an option (${name}) that was not declared.`);
         }
-        const converted = (0, declaration_2.convert)(value, declaration, configPath ?? process.cwd());
+        let oldValue = this._values[declaration.name];
+        if (typeof oldValue === "undefined")
+            oldValue = (0, declaration_2.getDefaultValue)(declaration);
+        const converted = (0, declaration_2.convert)(value, declaration, configPath ?? process.cwd(), oldValue);
         if (declaration.type === declaration_1.ParameterType.Flags) {
             Object.assign(this._values[declaration.name], converted);
         }

package/dist/lib/utils/package-manifest.d.ts

@@ -1,5 +1,5 @@
 import type { Logger } from "./loggers";
-import type { IMinimatch } from "minimatch";
+import type { Minimatch } from "minimatch";
 import { additionalProperties, Infer } from "./validation";
 /**
  * Loads a package.json and validates that it is a JSON Object
@@ -20,7 +20,7 @@ export declare function extractTypedocConfigFromPackageManifest(logger: Logger,
  * Given a list of (potentially wildcarded) package paths,
  * return all the actual package folders found.
  */
-export declare function expandPackages(logger: Logger, packageJsonDir: string, workspaces: string[], exclude: IMinimatch[]): string[];
+export declare function expandPackages(logger: Logger, packageJsonDir: string, workspaces: string[], exclude: Minimatch[]): string[];
 export declare const ignorePackage: unique symbol;
 /**
  * Given a package.json, attempt to find the TS file that defines its entry point

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

@@ -1,9 +1,9 @@
-import { IMinimatch } from "minimatch";
+import { Minimatch } from "minimatch";
 /**
  * Convert array of glob patterns to array of minimatch instances.
  *
  * Handle a few Windows-Unix path gotchas.
  */
-export declare function createMinimatch(patterns: string[]): IMinimatch[];
-export declare function matchesAny(patterns: readonly IMinimatch[], path: string): boolean;
+export declare function createMinimatch(patterns: string[]): Minimatch[];
+export declare function matchesAny(patterns: readonly Minimatch[], path: string): boolean;
 export declare function nicePath(absPath: string): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.23.11",
+  "version": "0.23.12",
   "homepage": "https://typedoc.org",
   "main": "./dist/index.js",
   "exports": {
@@ -35,15 +35,15 @@
   "devDependencies": {
     "@types/lunr": "^2.3.4",
     "@types/marked": "^4.0.6",
-    "@types/minimatch": "5.1.0",
+    "@types/minimatch": "5.1.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "14",
-    "@typescript-eslint/eslint-plugin": "^5.35.1",
-    "@typescript-eslint/parser": "^5.35.1",
+    "@typescript-eslint/eslint-plugin": "^5.36.1",
+    "@typescript-eslint/parser": "^5.36.1",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#b88cd06fe814614a0d924af9d10d04ff95a551de",
     "c8": "^7.12.0",
-    "esbuild": "^0.15.5",
-    "eslint": "^8.22.0",
+    "esbuild": "^0.15.6",
+    "eslint": "^8.23.0",
     "mocha": "^10.0.0",
     "prettier": "2.7.1",
     "puppeteer": "^13.5.2",

package/static/style.css

@@ -1109,6 +1109,7 @@ ul.tsd-type-parameter-list h5 {
     background: var(--color-background-secondary);
     border-bottom: 1px var(--color-accent) solid;
     transition: transform 0.3s ease-in-out;
+    margin: 0 auto;
 }
 .tsd-page-toolbar a {
     color: var(--color-text);