typedoc 0.22.7 → 0.22.11

package/dist/index.d.ts

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

package/dist/index.js

@@ -10,7 +10,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.SerializeEvent = exports.SerializerComponent = exports.Serializer = exports.JSONOutput = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.BindOption = exports.ArgumentsReader = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.normalizePath = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
+exports.TypeScript = exports.SerializeEvent = exports.SerializerComponent = exports.Serializer = exports.JSONOutput = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.BindOption = exports.ArgumentsReader = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.normalizePath = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
 var application_1 = require("./lib/application");
 Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });
 var events_1 = require("./lib/utils/events");
@@ -45,6 +45,7 @@ Object.defineProperty(exports, "ParameterType", { enumerable: true, get: functio
 Object.defineProperty(exports, "TSConfigReader", { enumerable: true, get: function () { return utils_1.TSConfigReader; } });
 Object.defineProperty(exports, "TypeDocReader", { enumerable: true, get: function () { return utils_1.TypeDocReader; } });
 Object.defineProperty(exports, "EntryPointStrategy", { enumerable: true, get: function () { return utils_1.EntryPointStrategy; } });
+Object.defineProperty(exports, "EventHooks", { enumerable: true, get: function () { return utils_1.EventHooks; } });
 var serialization_1 = require("./lib/serialization");
 Object.defineProperty(exports, "JSONOutput", { enumerable: true, get: function () { return serialization_1.JSONOutput; } });
 Object.defineProperty(exports, "Serializer", { enumerable: true, get: function () { return serialization_1.Serializer; } });

package/dist/lib/application.js

@@ -21,6 +21,7 @@ const exports_1 = require("./validation/exports");
 const assert_1 = require("assert");
 const entry_point_1 = require("./utils/entry-point");
 const paths_1 = require("./utils/paths");
+const general_1 = require("./utils/general");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageInfo = require("../../package.json");
 const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
@@ -79,9 +80,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
             this.options.setLogger(this.logger);
         }
         this.logger.level = this.options.getValue("logLevel");
-        const plugins = this.options.isSet("plugin")
-            ? this.options.getValue("plugin")
-            : (0, index_2.discoverNpmPlugins)(this);
+        const plugins = (0, index_2.discoverPlugins)(this);
         (0, index_2.loadPlugins)(this, plugins);
         this.options.reset();
         for (const [key, val] of Object.entries(options)) {
@@ -94,6 +93,9 @@ let Application = Application_1 = class Application extends component_1.Childabl
             }
         }
         this.options.read(this.logger);
+        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. This will likely break things.`);
+        }
     }
     /**
      * Return the application / root component instance.

package/dist/lib/converter/converter.js

@@ -354,6 +354,7 @@ function getSymbolForModuleLike(context, node) {
 }
 function getExports(context, node, symbol) {
     var _a;
+    let result;
     // The generated docs aren't great, but you really ought not be using
     // this in the first place... so it's better than nothing.
     const exportEq = (_a = symbol === null || symbol === void 0 ? void 0 : symbol.exports) === null || _a === void 0 ? void 0 : _a.get("export=");
@@ -361,21 +362,37 @@ function getExports(context, node, symbol) {
         // JS users might also have exported types here.
         // We need to filter for types because otherwise static methods can show up as both
         // members of the export= class and as functions if a class is directly exported.
-        return [exportEq].concat(context.checker
+        result = [exportEq].concat(context.checker
             .getExportsOfModule(symbol)
             .filter((s) => !(0, enum_1.hasAnyFlag)(s.flags, ts.SymbolFlags.Prototype | ts.SymbolFlags.Value)));
     }
-    if (symbol) {
-        return context.checker
+    else if (symbol) {
+        result = context.checker
             .getExportsOfModule(symbol)
             .filter((s) => !(0, enum_1.hasAllFlags)(s.flags, ts.SymbolFlags.Prototype));
     }
-    // Global file with no inferred top level symbol, get all symbols declared in this file.
-    const sourceFile = node.getSourceFile();
-    const globalSymbols = context.checker
-        .getSymbolsInScope(node, ts.SymbolFlags.ModuleMember)
-        .filter((s) => { var _a; return (_a = s.getDeclarations()) === null || _a === void 0 ? void 0 : _a.some((d) => d.getSourceFile() === sourceFile); });
-    return globalSymbols;
+    else {
+        // Global file with no inferred top level symbol, get all symbols declared in this file.
+        const sourceFile = node.getSourceFile();
+        result = context.checker
+            .getSymbolsInScope(node, ts.SymbolFlags.ModuleMember)
+            .filter((s) => {
+            var _a;
+            return (_a = s
+                .getDeclarations()) === null || _a === void 0 ? void 0 : _a.some((d) => d.getSourceFile() === sourceFile);
+        });
+    }
+    // Put symbols named "default" last, #1795
+    result.sort((a, b) => {
+        if (a.name === "default") {
+            return 1;
+        }
+        else if (b.name === "default") {
+            return -1;
+        }
+        return 0;
+    });
+    return result;
 }
 function isDirectExport(symbol, file) {
     var _a, _b;

package/dist/lib/converter/plugins/CategoryPlugin.js

@@ -143,9 +143,11 @@ let CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_
      * @returns The category the reflection belongs to
      */
     static getCategories(reflection) {
-        var _a, _b;
+        var _a, _b, _c;
         function extractCategoryTag(comment) {
             const categories = new Set();
+            if (!comment)
+                return categories;
             const tags = comment.tags;
             const commentTags = [];
             tags.forEach((tag) => {
@@ -162,23 +164,20 @@ let CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_
             comment.tags = commentTags;
             return categories;
         }
-        const categories = new Set();
+        let categories = new Set();
         if (reflection.comment) {
-            return extractCategoryTag(reflection.comment);
+            categories = extractCategoryTag(reflection.comment);
         }
-        else if (reflection instanceof models_1.DeclarationReflection &&
-            reflection.signatures) {
+        else if (reflection.signatures) {
             for (const sig of reflection.signatures) {
-                for (const cat of sig.comment
-                    ? extractCategoryTag(sig.comment)
-                    : []) {
+                for (const cat of extractCategoryTag(sig.comment)) {
                     categories.add(cat);
                 }
             }
         }
-        if (reflection.kind === models_1.ReflectionKind.TypeAlias &&
-            ((_a = reflection.type) === null || _a === void 0 ? void 0 : _a.type) === "reflection") {
+        if (((_a = reflection.type) === null || _a === void 0 ? void 0 : _a.type) === "reflection") {
             (_b = reflection.type.declaration.comment) === null || _b === void 0 ? void 0 : _b.removeTags("category");
+            (_c = reflection.type.declaration.signatures) === null || _c === void 0 ? void 0 : _c.forEach((s) => { var _a; return (_a = s.comment) === null || _a === void 0 ? void 0 : _a.removeTags("category"); });
         }
         return categories;
     }

package/dist/lib/converter/plugins/DecoratorPlugin.js

@@ -82,7 +82,7 @@ let DecoratorPlugin = class DecoratorPlugin extends components_1.ConverterCompon
             };
             const type = context.checker.getTypeAtLocation(identifier);
             if (type && type.symbol) {
-                info.type = new types_1.ReferenceType(info.name, context.resolveAliasedSymbol(type.symbol), context.project);
+                info.type = types_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(type.symbol), context, info.name);
                 if (callExpression && callExpression.arguments) {
                     const signature = context.checker.getResolvedSignature(callExpression);
                     if (signature) {
@@ -90,7 +90,7 @@ let DecoratorPlugin = class DecoratorPlugin extends components_1.ConverterCompon
                     }
                 }
                 const usages = (_a = this.usages.get(type.symbol)) !== null && _a !== void 0 ? _a : [];
-                usages.push(new types_1.ReferenceType(reflection.name, reflection, context.project));
+                usages.push(types_1.ReferenceType.createResolvedReference(reflection.name, reflection, context.project));
                 this.usages.set(type.symbol, usages);
             }
             (_b = reflection.decorators) !== null && _b !== void 0 ? _b : (reflection.decorators = []);

package/dist/lib/converter/plugins/ImplementsPlugin.js

@@ -63,7 +63,8 @@ let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComp
                 return;
             }
             const interfaceMemberName = interfaceReflection.name + "." + interfaceMember.name;
-            classMember.implementationOf = new types_1.ReferenceType(interfaceMemberName, interfaceMember, context.project);
+            classMember.implementationOf =
+                types_1.ReferenceType.createResolvedReference(interfaceMemberName, interfaceMember, context.project);
             (0, reflections_1.copyComment)(classMember, interfaceMember);
             if (interfaceMember.kindOf(index_1.ReflectionKind.Property) &&
                 classMember.kindOf(index_1.ReflectionKind.Accessor)) {
@@ -83,7 +84,8 @@ let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComp
                 classMember.signatures) {
                 for (const [clsSig, intSig] of (0, array_1.zip)(classMember.signatures, interfaceMember.signatures)) {
                     if (clsSig.implementationOf) {
-                        clsSig.implementationOf = new types_1.ReferenceType(clsSig.implementationOf.name, intSig, context.project);
+                        clsSig.implementationOf =
+                            types_1.ReferenceType.createResolvedReference(clsSig.implementationOf.name, intSig, context.project);
                     }
                     (0, reflections_1.copyComment)(clsSig, intSig);
                 }
@@ -107,10 +109,10 @@ let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComp
                         ? "overwrites"
                         : "inheritedFrom";
                     for (const [childSig, parentSig] of (0, array_1.zip)((_d = child.signatures) !== null && _d !== void 0 ? _d : [], (_e = parentMember.signatures) !== null && _e !== void 0 ? _e : [])) {
-                        childSig[key] = new types_1.ReferenceType(`${parent.name}.${parentMember.name}`, parentSig, context.project);
+                        childSig[key] = types_1.ReferenceType.createResolvedReference(`${parent.name}.${parentMember.name}`, parentSig, context.project);
                         (0, reflections_1.copyComment)(childSig, parentSig);
                     }
-                    child[key] = new types_1.ReferenceType(`${parent.name}.${parentMember.name}`, parentMember, context.project);
+                    child[key] = types_1.ReferenceType.createResolvedReference(`${parent.name}.${parentMember.name}`, parentMember, context.project);
                     (0, reflections_1.copyComment)(child, parentMember);
                 }
             }

package/dist/lib/converter/plugins/TypePlugin.js

@@ -43,14 +43,14 @@ let TypePlugin = class TypePlugin extends components_1.ConverterComponent {
                 if (!target.implementedBy) {
                     target.implementedBy = [];
                 }
-                target.implementedBy.push(new types_1.ReferenceType(reflection.name, reflection, context.project));
+                target.implementedBy.push(types_1.ReferenceType.createResolvedReference(reflection.name, reflection, context.project));
             });
             walk(reflection.extendedTypes, (target) => {
                 this.postpone(target);
                 if (!target.extendedBy) {
                     target.extendedBy = [];
                 }
-                target.extendedBy.push(new types_1.ReferenceType(reflection.name, reflection, context.project));
+                target.extendedBy.push(types_1.ReferenceType.createResolvedReference(reflection.name, reflection, context.project));
             });
         }
         function walk(types, callback) {
@@ -101,7 +101,7 @@ let TypePlugin = class TypePlugin extends components_1.ConverterComponent {
                 push(reflection.extendedTypes);
             }
             push([
-                new types_1.ReferenceType(reflection.name, reflection, context.project),
+                types_1.ReferenceType.createResolvedReference(reflection.name, reflection, context.project),
             ]);
             hierarchy.isTarget = true;
             if (reflection.extendedBy) {

package/dist/lib/converter/symbols.js

@@ -99,7 +99,10 @@ function convertSymbol(context, symbol, exportSymbol) {
         // This might be here if a namespace is declared several times.
         flags = (0, enum_1.removeFlag)(flags, ts.SymbolFlags.ValueModule);
     }
-    if ((0, enum_1.hasAllFlags)(symbol.flags, ts.SymbolFlags.Method)) {
+    if ((0, enum_1.hasAnyFlag)(symbol.flags, ts.SymbolFlags.Method |
+        ts.SymbolFlags.Interface |
+        ts.SymbolFlags.Class |
+        ts.SymbolFlags.Variable)) {
         // This happens when someone declares an object with methods:
         // { methodProperty() {} }
         flags = (0, enum_1.removeFlag)(flags, ts.SymbolFlags.Property);
@@ -528,7 +531,7 @@ function convertAccessor(context, symbol, exportSymbol) {
 function isInherited(context, symbol) {
     var _a;
     const parentSymbol = context.project.getSymbolFromReflection(context.scope);
-    assert(parentSymbol);
+    assert(parentSymbol, `No parent symbol found for ${symbol.name} in ${context.scope.name}`);
     return (((_a = parentSymbol
         .getDeclarations()) === null || _a === void 0 ? void 0 : _a.some((d) => { var _a; return (_a = symbol.getDeclarations()) === null || _a === void 0 ? void 0 : _a.some((d2) => d2.parent === d); })) === false);
 }

package/dist/lib/converter/types.js

@@ -167,7 +167,7 @@ const exprWithTypeArgsConverter = {
             return convertType(context, context.checker.getTypeAtLocation(node));
         }
         const parameters = (_b = (_a = node.typeArguments) === null || _a === void 0 ? void 0 : _a.map((type) => convertType(context, type))) !== null && _b !== void 0 ? _b : [];
-        const ref = new models_1.ReferenceType(targetSymbol.name, context.resolveAliasedSymbol(targetSymbol), context.project);
+        const ref = models_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(targetSymbol), context);
         ref.typeArguments = parameters;
         return ref;
     },
@@ -213,12 +213,12 @@ const importType = {
         const name = (_b = (_a = node.qualifier) === null || _a === void 0 ? void 0 : _a.getText()) !== null && _b !== void 0 ? _b : "__module";
         const symbol = context.checker.getSymbolAtLocation(node);
         assert(symbol, "Missing symbol when converting import type node");
-        return new models_1.ReferenceType(name, context.resolveAliasedSymbol(symbol), context.project);
+        return models_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(symbol), context, name);
     },
     convertType(context, type) {
         const symbol = type.getSymbol();
         assert(symbol, "Missing symbol when converting import type"); // Should be a compiler error
-        return new models_1.ReferenceType("__module", context.resolveAliasedSymbol(symbol), context.project);
+        return models_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(symbol), context, "__module");
     },
 };
 const indexedAccessConverter = {
@@ -371,12 +371,12 @@ const queryConverter = {
             // on a variable typed as `any` with a name that doesn't exist.
             return new models_1.QueryType(models_1.ReferenceType.createBrokenReference(node.exprName.getText(), context.project));
         }
-        return new models_1.QueryType(new models_1.ReferenceType(node.exprName.getText(), context.resolveAliasedSymbol(querySymbol), context.project));
+        return new models_1.QueryType(models_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(querySymbol), context, node.exprName.getText()));
     },
     convertType(context, type) {
         const symbol = type.getSymbol();
         assert(symbol, `Query type failed to get a symbol for: ${context.checker.typeToString(type)}. This is a bug.`);
-        return new models_1.QueryType(new models_1.ReferenceType(symbol.name, context.resolveAliasedSymbol(symbol), context.project));
+        return new models_1.QueryType(models_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(symbol), context));
     },
 };
 const referenceConverter = {
@@ -389,7 +389,7 @@ const referenceConverter = {
         }
         const symbol = context.expectSymbolAtLocation(node.typeName);
         const name = node.typeName.getText();
-        const type = new models_1.ReferenceType(name, context.resolveAliasedSymbol(symbol), context.project);
+        const type = models_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(symbol), context, name);
         type.typeArguments = (_c = node.typeArguments) === null || _c === void 0 ? void 0 : _c.map((type) => convertType(context, type));
         return type;
     },
@@ -401,7 +401,7 @@ const referenceConverter = {
             // created within a mapped type, `K` in: `{ [K in T]: string }`
             return models_1.ReferenceType.createBrokenReference(context.checker.typeToString(type), context.project);
         }
-        const ref = new models_1.ReferenceType(symbol.name, context.resolveAliasedSymbol(symbol), context.project);
+        const ref = models_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(symbol), context);
         ref.typeArguments = (_b = (type.aliasSymbol ? type.aliasTypeArguments : type.typeArguments)) === null || _b === void 0 ? void 0 : _b.map((ref) => convertType(context, ref));
         return ref;
     },

package/dist/lib/models/reflections/declaration.d.ts

@@ -48,7 +48,7 @@ export declare class DeclarationReflection extends ContainerReflection {
     /**
      * A list of call signatures attached to this declaration.
      *
-     * TypeDoc creates one declaration per function that may contain ore or more
+     * TypeDoc creates one declaration per function that may contain one or more
      * signature reflections.
      */
     signatures?: SignatureReflection[];

package/dist/lib/models/types.d.ts

@@ -1,4 +1,5 @@
 import type * as ts from "typescript";
+import type { Context } from "../converter";
 import { Reflection } from "./reflections/abstract";
 import type { DeclarationReflection } from "./reflections/declaration";
 import type { ProjectReflection } from "./reflections/project";
@@ -247,10 +248,29 @@ export declare class ReferenceType extends Type {
      * The resolved reflection.
      */
     get reflection(): Reflection | undefined;
+    /**
+     * Don't use this if at all possible. It will eventually go away since models may not
+     * retain information from the original TS objects to enable documentation generation from
+     * previously generated JSON.
+     * @internal
+     */
     getSymbol(): ts.Symbol | undefined;
+    /**
+     * The fully qualified name of the referenced type, relative to the file it is defined in.
+     * This will usually be the same as `name`, unless namespaces are used.
+     * Will only be set for `ReferenceType`s pointing to a symbol within `node_modules`.
+     */
+    qualifiedName?: string;
+    /**
+     * The package that this type is referencing.
+     * Will only be set for `ReferenceType`s pointing to a symbol within `node_modules`.
+     */
+    package?: string;
     private _target;
     private _project;
-    constructor(name: string, target: ts.Symbol | Reflection | number, project: ProjectReflection | null);
+    private constructor();
+    static createResolvedReference(name: string, target: Reflection | number, project: ProjectReflection | null): ReferenceType;
+    static createSymbolReference(symbol: ts.Symbol, context: Context, name?: string): ReferenceType;
     /** @internal this is used for type parameters, which don't actually point to something */
     static createBrokenReference(name: string, project: ProjectReflection): ReferenceType;
     toString(): string;

package/dist/lib/models/types.js

@@ -430,12 +430,51 @@ class ReferenceType extends Type {
             this._target = resolved.id;
         return resolved;
     }
+    /**
+     * Don't use this if at all possible. It will eventually go away since models may not
+     * retain information from the original TS objects to enable documentation generation from
+     * previously generated JSON.
+     * @internal
+     */
     getSymbol() {
         if (typeof this._target === "number") {
             return;
         }
         return this._target;
     }
+    static createResolvedReference(name, target, project) {
+        return new ReferenceType(name, target, project);
+    }
+    static createSymbolReference(symbol, context, name) {
+        var _a, _b;
+        const ref = new ReferenceType(name !== null && name !== void 0 ? name : symbol.name, symbol, context.project);
+        const symbolPath = (_b = (_a = symbol === null || symbol === void 0 ? void 0 : symbol.declarations) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.getSourceFile().fileName.replace(/\\/g, "/");
+        if (!symbolPath)
+            return ref;
+        let startIndex = symbolPath.indexOf("node_modules/");
+        if (startIndex === -1)
+            return ref;
+        startIndex += "node_modules/".length;
+        let stopIndex = symbolPath.indexOf("/", startIndex);
+        // Scoped package, e.g. `@types/node`
+        if (symbolPath[startIndex] === "@") {
+            stopIndex = symbolPath.indexOf("/", stopIndex + 1);
+        }
+        const packageName = symbolPath.substring(startIndex, stopIndex);
+        ref.package = packageName;
+        const qualifiedName = context.checker.getFullyQualifiedName(symbol);
+        // I think this is less bad than depending on symbol.parent...
+        // https://github.com/microsoft/TypeScript/issues/38344
+        // It will break if someone names a directory with a quote in it, but so will lots
+        // of other things including other parts of TypeDoc. Until it *actually* breaks someone...
+        if (qualifiedName.startsWith('"')) {
+            ref.qualifiedName = qualifiedName.substring(qualifiedName.indexOf('".', 1) + 2);
+        }
+        else {
+            ref.qualifiedName = qualifiedName;
+        }
+        return ref;
+    }
     /** @internal this is used for type parameters, which don't actually point to something */
     static createBrokenReference(name, project) {
         return new ReferenceType(name, -1, project);

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

@@ -2,6 +2,7 @@ export { PageEvent, RendererEvent, MarkdownEvent } from "./events";
 export { UrlMapping } from "./models/UrlMapping";
 export type { RenderTemplate } from "./models/UrlMapping";
 export { Renderer } from "./renderer";
+export type { RendererHooks } from "./renderer";
 export { Theme } from "./theme";
 export { DefaultTheme } from "./themes/default/DefaultTheme";
 export { DefaultThemeRenderContext } from "./themes/default/DefaultThemeRenderContext";

package/dist/lib/output/plugins/JavascriptIndexPlugin.js

@@ -83,7 +83,7 @@ let JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.Ren
             rows,
             index,
         });
-        (0, utils_1.writeFileSync)(jsonFileName, `window.searchData = ${jsonData}`);
+        (0, utils_1.writeFileSync)(jsonFileName, `window.searchData = JSON.parse(${JSON.stringify(jsonData)});`);
     }
 };
 JavascriptIndexPlugin = __decorate([

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

@@ -1,18 +1,35 @@
-/**
- * Holds all logic used render and output the final documentation.
- *
- * The {@link Renderer} class is the central controller within this namespace. When invoked it creates
- * an instance of {@link Theme} which defines the layout of the documentation and fires a
- * series of {@link RendererEvent} events. Instances of {@link BasePlugin} can listen to these events and
- * alter the generated output.
- */
-import type * as ts from "typescript";
 import type { Application } from "../application";
 import type { Theme } from "./theme";
 import type { ProjectReflection } from "../models/reflections/project";
 import { RendererComponent } from "./components";
 import { ChildableComponent } from "../utils/component";
+import { EventHooks } from "../utils";
 import type { Theme as ShikiTheme } from "shiki";
+import { ReferenceType } from "../models";
+import type { JsxElement } from "../utils/jsx.elements";
+import type { DefaultThemeRenderContext } from "./themes/default/DefaultThemeRenderContext";
+/**
+ * Describes the hooks available to inject output in the default theme.
+ * If the available hooks don't let you put something where you'd like, please open an issue!
+ */
+export interface RendererHooks {
+    /**
+     * Applied immediately after the opening `<head>` tag.
+     */
+    "head.begin": [DefaultThemeRenderContext];
+    /**
+     * Applied immediately before the closing `</head>` tag.
+     */
+    "head.end": [DefaultThemeRenderContext];
+    /**
+     * Applied immediately after the opening `<body>` tag.
+     */
+    "body.begin": [DefaultThemeRenderContext];
+    /**
+     * Applied immediately before the closing `</body>` tag.
+     */
+    "body.end": [DefaultThemeRenderContext];
+}
 /**
  * The renderer processes a {@link ProjectReflection} using a {@link Theme} instance and writes
  * the emitted html documents to a output directory. You can specify which theme should be used
@@ -56,11 +73,22 @@ export declare class Renderer extends ChildableComponent<Application, RendererCo
      * The theme that is used to render the documentation.
      */
     theme?: Theme;
+    /**
+     * Hooks which will be called when rendering pages.
+     * Note:
+     * - Hooks added during output will be discarded at the end of rendering.
+     * - Hooks added during a page render will be discarded at the end of that page's render.
+     *
+     * See {@link RendererHooks} for a description of each available hook, and when it will be called.
+     */
+    hooks: EventHooks<RendererHooks, JsxElement>;
     /** @internal */
     themeName: string;
     /** @internal */
     cleanOutputDir: boolean;
     /** @internal */
+    cname: string;
+    /** @internal */
     gaID: string;
     /** @internal */
     gaSite: string;
@@ -99,7 +127,7 @@ export declare class Renderer extends ChildableComponent<Application, RendererCo
      * symbols so that we don't need to keep the program around forever.
      * @internal
      */
-    attemptExternalResolution(symbol: ts.Symbol | undefined): string | undefined;
+    attemptExternalResolution(type: ReferenceType): string | undefined;
     /**
      * Render the given project reflection to the specified output directory.
      *

package/dist/lib/output/renderer.js

@@ -7,6 +7,14 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Renderer = void 0;
+/**
+ * Holds all logic used render and output the final documentation.
+ *
+ * The {@link Renderer} class is the central controller within this namespace. When invoked it creates
+ * an instance of {@link Theme} which defines the layout of the documentation and fires a
+ * series of {@link RendererEvent} events. Instances of {@link BasePlugin} can listen to these events and
+ * alter the generated output.
+ */
 const fs = require("fs");
 const path = require("path");
 const events_1 = require("./events");
@@ -52,6 +60,15 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
             ["default", DefaultTheme_1.DefaultTheme],
         ]);
         this.unknownSymbolResolvers = new Map();
+        /**
+         * Hooks which will be called when rendering pages.
+         * Note:
+         * - Hooks added during output will be discarded at the end of rendering.
+         * - Hooks added during a page render will be discarded at the end of that page's render.
+         *
+         * See {@link RendererHooks} for a description of each available hook, and when it will be called.
+         */
+        this.hooks = new utils_1.EventHooks();
     }
     /**
      * Define a new theme that can be used to render output.
@@ -93,26 +110,13 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
      * symbols so that we don't need to keep the program around forever.
      * @internal
      */
-    attemptExternalResolution(symbol) {
-        var _a, _b;
-        const symbolPath = (_b = (_a = symbol === null || symbol === void 0 ? void 0 : symbol.declarations) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.getSourceFile().fileName.replace(/\\/g, "/");
-        if (!symbolPath) {
-            return;
-        }
-        let startIndex = symbolPath.indexOf("node_modules/");
-        if (startIndex === -1) {
+    attemptExternalResolution(type) {
+        if (!type.qualifiedName || !type.package) {
             return;
         }
-        startIndex += "node_modules/".length;
-        let stopIndex = symbolPath.indexOf("/", startIndex);
-        // Scoped package, e.g. `@types/node`
-        if (symbolPath[startIndex] === "@") {
-            stopIndex = symbolPath.indexOf("/", stopIndex + 1);
-        }
-        const packageName = symbolPath.substring(startIndex, stopIndex);
-        const resolvers = this.unknownSymbolResolvers.get(packageName);
+        const resolvers = this.unknownSymbolResolvers.get(type.package);
         for (const resolver of resolvers || []) {
-            const resolved = resolver(symbol.name);
+            const resolved = resolver(type.qualifiedName);
             if (resolved)
                 return resolved;
         }
@@ -124,6 +128,7 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
      * @param outputDirectory  The path of the directory the documentation should be rendered to.
      */
     async render(project, outputDirectory) {
+        const momento = this.hooks.saveMomento();
         const start = Date.now();
         await (0, highlighter_1.loadHighlighter)(this.lightTheme, this.darkTheme);
         this.application.logger.verbose(`Renderer: Loading highlighter took ${Date.now() - start}ms`);
@@ -141,6 +146,7 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
             this.trigger(events_1.RendererEvent.END, output);
         }
         this.theme = void 0;
+        this.hooks.restoreMomento(momento);
     }
     /**
      * Render a single page.
@@ -149,8 +155,10 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
      * @return TRUE if the page has been saved to disc, otherwise FALSE.
      */
     renderDocument(page) {
+        const momento = this.hooks.saveMomento();
         this.trigger(events_1.PageEvent.BEGIN, page);
         if (page.isDefaultPrevented) {
+            this.hooks.restoreMomento(momento);
             return false;
         }
         if (page.model instanceof models_1.Reflection) {
@@ -160,6 +168,7 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
             throw new Error("Should be unreachable");
         }
         this.trigger(events_1.PageEvent.END, page);
+        this.hooks.restoreMomento(momento);
         if (page.isDefaultPrevented) {
             return false;
         }
@@ -231,6 +240,9 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
                 return false;
             }
         }
+        if (this.cname) {
+            fs.writeFileSync(path.join(directory, "CNAME"), this.cname);
+        }
         return true;
     }
 };
@@ -248,6 +260,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("cleanOutputDir")
 ], Renderer.prototype, "cleanOutputDir", void 0);
+__decorate([
+    (0, utils_1.BindOption)("cname")
+], Renderer.prototype, "cname", void 0);
 __decorate([
     (0, utils_1.BindOption)("gaID")
 ], Renderer.prototype, "gaID", void 0);