typedoc 0.24.0-beta.7 → 0.24.0

package/dist/index.d.ts

@@ -2,6 +2,10 @@ export { Application } from "./lib/application";
 export { EventDispatcher, Event } from "./lib/utils/events";
 export { resetReflectionID } from "./lib/models/reflections/abstract";
 export { normalizePath } from "./lib/utils/fs";
+/**
+ * All symbols documented under the Models namespace are also available in the root import.
+ */
+export * as Models from "./lib/models";
 export * from "./lib/models";
 export { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, type ExternalResolveResult, type ExternalSymbolResolver, } from "./lib/converter";
 export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";

package/dist/index.js

@@ -10,6 +10,18 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 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);
 };
@@ -17,7 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.IndexEvent = 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.Deserializer = exports.Serializer = exports.JSONOutput = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Models = 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");
@@ -27,6 +39,10 @@ var abstract_1 = require("./lib/models/reflections/abstract");
 Object.defineProperty(exports, "resetReflectionID", { enumerable: true, get: function () { return abstract_1.resetReflectionID; } });
 var fs_1 = require("./lib/utils/fs");
 Object.defineProperty(exports, "normalizePath", { enumerable: true, get: function () { return fs_1.normalizePath; } });
+/**
+ * All symbols documented under the Models namespace are also available in the root import.
+ */
+exports.Models = __importStar(require("./lib/models"));
 __exportStar(require("./lib/models"), exports);
 var converter_1 = require("./lib/converter");
 Object.defineProperty(exports, "Converter", { enumerable: true, get: function () { return converter_1.Converter; } });

package/dist/lib/converter/comments/discovery.js

@@ -173,7 +173,7 @@ function discoverSignatureComment(declaration, commentStyle) {
                     end: comment.end,
                 },
             ],
-            jsDoc: undefined,
+            jsDoc: comment,
         };
     }
     const text = node.getSourceFile().text;

package/dist/lib/converter/comments/index.d.ts

@@ -1,11 +1,12 @@
 import ts from "typescript";
 import { Comment, ReflectionKind } from "../../models";
 import { Logger } from "../../utils";
-import type { CommentStyle } from "../../utils/options/declaration";
+import type { CommentStyle, JsDocCompatibility } from "../../utils/options/declaration";
 export interface CommentParserConfig {
     blockTags: Set<string>;
     inlineTags: Set<string>;
     modifierTags: Set<string>;
+    jsDocCompatibility: JsDocCompatibility;
 }
 export declare function clearCommentCache(): void;
 export declare function getComment(symbol: ts.Symbol, kind: ReflectionKind, config: CommentParserConfig, logger: Logger, commentStyle: CommentStyle, checker: ts.TypeChecker | undefined): Comment | undefined;

package/dist/lib/converter/comments/parser.js

@@ -127,17 +127,47 @@ function blockTag(comment, lexer, config, warning) {
     (0, assert_1.ok)(blockTag.kind === lexer_1.TokenSyntaxKind.Tag, "blockTag called not at the start of a block tag."); // blockContent is broken if this fails.
     const tagName = aliasedTags.get(blockTag.text) || blockTag.text;
     let content;
-    if (tagName === "@example") {
+    if (tagName === "@example" && config.jsDocCompatibility.exampleTag) {
         content = exampleBlockContent(comment, lexer, config, warning);
     }
+    else if (tagName === "@default" && config.jsDocCompatibility.defaultTag) {
+        content = defaultBlockContent(comment, lexer, config, warning);
+    }
     else {
         content = blockContent(comment, lexer, config, warning);
     }
     return new models_1.CommentTag(tagName, content);
 }
+/**
+ * The `@default` tag gets a special case because otherwise we will produce many warnings
+ * about unescaped/mismatched/missing braces in legacy JSDoc comments
+ */
+function defaultBlockContent(comment, lexer, config, warning) {
+    lexer.mark();
+    const content = blockContent(comment, lexer, config, () => { });
+    const end = lexer.done() || lexer.peek();
+    lexer.release();
+    if (content.some((part) => part.kind === "code")) {
+        return blockContent(comment, lexer, config, warning);
+    }
+    const tokens = [];
+    while ((lexer.done() || lexer.peek()) !== end) {
+        tokens.push(lexer.take());
+    }
+    const blockText = tokens
+        .map((tok) => tok.text)
+        .join("")
+        .trim();
+    return [
+        {
+            kind: "code",
+            text: makeCodeBlock(blockText),
+        },
+    ];
+}
 /**
  * The `@example` tag gets a special case because otherwise we will produce many warnings
- * about unescaped/mismatched/missing braces
+ * about unescaped/mismatched/missing braces in legacy JSDoc comments.
  */
 function exampleBlockContent(comment, lexer, config, warning) {
     lexer.mark();

package/dist/lib/converter/context.js

@@ -114,10 +114,10 @@ class Context {
         if (exportSymbol &&
             reflection.kind &
                 (index_1.ReflectionKind.SomeModule | index_1.ReflectionKind.Reference)) {
-            reflection.comment = (0, comments_1.getComment)(exportSymbol, reflection.kind, this.converter.config, this.logger, this.converter.commentStyle, this.converter.useTsLinkResolution ? this.checker : undefined);
+            reflection.comment = this.getComment(exportSymbol, reflection.kind);
         }
         if (symbol && !reflection.comment) {
-            reflection.comment = (0, comments_1.getComment)(symbol, reflection.kind, this.converter.config, this.logger, this.converter.commentStyle, this.converter.useTsLinkResolution ? this.checker : undefined);
+            reflection.comment = this.getComment(symbol, reflection.kind);
         }
         if (this.shouldBeStatic) {
             reflection.setFlag(index_1.ReflectionFlag.Static);

package/dist/lib/converter/converter.d.ts

@@ -27,6 +27,8 @@ export declare class Converter extends ChildableComponent<Application, Converter
     /** @internal */
     excludeProtected: boolean;
     /** @internal */
+    excludeReferences: boolean;
+    /** @internal */
     commentStyle: CommentStyle;
     /** @internal */
     validation: ValidationOptions;
@@ -57,13 +59,13 @@ export declare class Converter extends ChildableComponent<Application, Converter
      */
     /**
      * Triggered when the converter has created a declaration reflection.
-     * The listener will be given {@link Context} and a {@link DeclarationReflection}.
+     * The listener will be given {@link Context} and a {@link Models.DeclarationReflection}.
      * @event
      */
     static readonly EVENT_CREATE_DECLARATION: "createDeclaration";
     /**
      * Triggered when the converter has created a signature reflection.
-     * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} the declaration,
+     * The listener will be given {@link Context}, {@link Models.SignatureReflection} | {@link Models.ProjectReflection} the declaration,
      * `ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined`,
      * and `ts.Signature | undefined`. The signature will be undefined if the created signature is an index signature.
      * @event
@@ -71,13 +73,13 @@ export declare class Converter extends ChildableComponent<Application, Converter
     static readonly EVENT_CREATE_SIGNATURE: "createSignature";
     /**
      * Triggered when the converter has created a parameter reflection.
-     * The listener will be given {@link Context}, {@link ParameterReflection} and a `ts.Node?`
+     * The listener will be given {@link Context}, {@link Models.ParameterReflection} and a `ts.Node?`
      * @event
      */
     static readonly EVENT_CREATE_PARAMETER: "createParameter";
     /**
      * Triggered when the converter has created a type parameter reflection.
-     * The listener will be given {@link Context} and a {@link TypeParameterReflection}
+     * The listener will be given {@link Context} and a {@link Models.TypeParameterReflection}
      * @event
      */
     static readonly EVENT_CREATE_TYPE_PARAMETER: "createTypeParameter";

package/dist/lib/converter/converter.js

@@ -72,7 +72,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         this.compile(entryPoints, context);
         this.resolve(context);
         this.trigger(Converter_1.EVENT_END, context);
-        project.forgetTsReferences();
+        this._config = undefined;
         return project;
     }
     /** @internal */
@@ -239,6 +239,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
             blockTags: new Set(this.application.options.getValue("blockTags")),
             inlineTags: new Set(this.application.options.getValue("inlineTags")),
             modifierTags: new Set(this.application.options.getValue("modifierTags")),
+            jsDocCompatibility: this.application.options.getValue("jsDocCompatibility"),
         };
         return this._config;
     }
@@ -263,13 +264,13 @@ Converter.EVENT_END = converter_events_1.ConverterEvents.END;
  */
 /**
  * Triggered when the converter has created a declaration reflection.
- * The listener will be given {@link Context} and a {@link DeclarationReflection}.
+ * The listener will be given {@link Context} and a {@link Models.DeclarationReflection}.
  * @event
  */
 Converter.EVENT_CREATE_DECLARATION = converter_events_1.ConverterEvents.CREATE_DECLARATION;
 /**
  * Triggered when the converter has created a signature reflection.
- * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} the declaration,
+ * The listener will be given {@link Context}, {@link Models.SignatureReflection} | {@link Models.ProjectReflection} the declaration,
  * `ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined`,
  * and `ts.Signature | undefined`. The signature will be undefined if the created signature is an index signature.
  * @event
@@ -277,13 +278,13 @@ Converter.EVENT_CREATE_DECLARATION = converter_events_1.ConverterEvents.CREATE_D
 Converter.EVENT_CREATE_SIGNATURE = converter_events_1.ConverterEvents.CREATE_SIGNATURE;
 /**
  * Triggered when the converter has created a parameter reflection.
- * The listener will be given {@link Context}, {@link ParameterReflection} and a `ts.Node?`
+ * The listener will be given {@link Context}, {@link Models.ParameterReflection} and a `ts.Node?`
  * @event
  */
 Converter.EVENT_CREATE_PARAMETER = converter_events_1.ConverterEvents.CREATE_PARAMETER;
 /**
  * Triggered when the converter has created a type parameter reflection.
- * The listener will be given {@link Context} and a {@link TypeParameterReflection}
+ * The listener will be given {@link Context} and a {@link Models.TypeParameterReflection}
  * @event
  */
 Converter.EVENT_CREATE_TYPE_PARAMETER = converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER;
@@ -323,6 +324,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("excludeProtected")
 ], Converter.prototype, "excludeProtected", void 0);
+__decorate([
+    (0, utils_1.BindOption)("excludeReferences")
+], Converter.prototype, "excludeReferences", void 0);
 __decorate([
     (0, utils_1.BindOption)("commentStyle")
 ], Converter.prototype, "commentStyle", void 0);

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

@@ -50,6 +50,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
             [converter_1.Converter.EVENT_RESOLVE_BEGIN]: this.onBeginResolve,
             [converter_1.Converter.EVENT_END]: () => {
                 delete this.readmeFile;
+                delete this.readmeContents;
                 delete this.packageJson;
             },
         });
@@ -62,6 +63,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
         this.addEntries(project);
         delete this.readmeFile;
         delete this.packageJson;
+        delete this.readmeContents;
     }
     onBegin() {
         this.readmeFile = undefined;
@@ -117,7 +119,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
                 project.name = project.packageName || "Documentation";
             }
             if (this.includeVersion) {
-                project.packageVersion = this.packageJson.version;
+                project.packageVersion = this.packageJson.version?.replace(/^v/, "");
             }
         }
         else if (!project.name) {

package/dist/lib/converter/symbols.js

@@ -80,7 +80,7 @@ function convertSymbol(context, symbol, exportSymbol) {
     // but aren't aliased symbols because `export *` was used.
     const previous = context.project.getReflectionFromSymbol(symbol);
     if (previous &&
-        previous.parent?.kindOf(models_1.ReflectionKind.Module | models_1.ReflectionKind.Project)) {
+        previous.parent?.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
         createAlias(previous, context, symbol, exportSymbol);
         return;
     }
@@ -191,7 +191,9 @@ function convertTypeAlias(context, symbol, exportSymbol) {
         typescript_1.default.isJSDocEnumTag(d));
     (0, assert_1.default)(declaration);
     if (typescript_1.default.isTypeAliasDeclaration(declaration)) {
-        if (symbol.getJsDocTags().some((tag) => tag.name === "interface")) {
+        if (context
+            .getComment(symbol, models_1.ReflectionKind.TypeAlias)
+            ?.hasModifier("@interface")) {
             return convertTypeAliasAsInterface(context, symbol, exportSymbol, declaration);
         }
         const reflection = context.createDeclarationReflection(models_1.ReflectionKind.TypeAlias, symbol, exportSymbol);
@@ -444,6 +446,8 @@ function convertAlias(context, symbol, exportSymbol) {
     }
 }
 function createAlias(target, context, symbol, exportSymbol) {
+    if (context.converter.excludeReferences)
+        return;
     // We already have this. Create a reference.
     const ref = new models_1.ReferenceReflection(exportSymbol?.name ?? symbol.name, target, context.scope);
     context.postReflectionCreation(ref, symbol, exportSymbol);
@@ -452,12 +456,13 @@ function createAlias(target, context, symbol, exportSymbol) {
 function convertVariable(context, symbol, exportSymbol) {
     const declaration = symbol.getDeclarations()?.[0];
     (0, assert_1.default)(declaration);
+    const comment = context.getComment(symbol, models_1.ReflectionKind.Variable);
     const type = context.checker.getTypeOfSymbolAtLocation(symbol, declaration);
     if (isEnumLike(context.checker, type, declaration) &&
-        symbol.getJsDocTags().some((tag) => tag.name === "enum")) {
+        comment?.hasModifier("@enum")) {
         return convertVariableAsEnum(context, symbol, exportSymbol);
     }
-    if (symbol.getJsDocTags().some((tag) => tag.name === "namespace")) {
+    if (comment?.hasModifier("@namespace")) {
         return convertVariableAsNamespace(context, symbol, exportSymbol);
     }
     if (type.getCallSignatures().length) {

package/dist/lib/converter/types.js

@@ -392,8 +392,8 @@ const queryConverter = {
         }
         return new models_1.QueryType(models_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(querySymbol), context, node.exprName.getText()));
     },
-    convertType(context, type) {
-        const symbol = type.getSymbol();
+    convertType(context, type, node) {
+        const symbol = type.getSymbol() || context.getSymbolAtLocation(node.exprName);
         (0, assert_1.default)(symbol, `Query type failed to get a symbol for: ${context.checker.typeToString(type)}. This is a bug.`);
         return new models_1.QueryType(models_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(symbol), context));
     },

package/dist/lib/models/comments/comment.d.ts

@@ -1,4 +1,5 @@
-import type { Reflection, ReflectionSymbolId } from "../reflections";
+import type { Reflection } from "../reflections";
+import { ReflectionSymbolId } from "../reflections/ReflectionSymbolId";
 import type { Serializer, Deserializer, JSONOutput } from "../../serialization";
 export type CommentDisplayPart = {
     kind: "text";
@@ -99,7 +100,6 @@ export declare class Comment {
     modifierTags: Set<string>;
     /**
      * Label associated with this reflection, if any (https://tsdoc.org/pages/tags/label/)
-     * Added by the CommentPlugin during resolution.
      */
     label?: string;
     /**

package/dist/lib/models/comments/comment.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Comment = exports.CommentTag = void 0;
 const utils_1 = require("../../utils");
+const ReflectionSymbolId_1 = require("../reflections/ReflectionSymbolId");
 /**
  * A model that represents a single TypeDoc comment tag.
  *
@@ -162,20 +163,39 @@ class Comment {
                 case "code":
                     return { ...part };
                 case "inline-tag": {
-                    if (typeof part.target !== "number") {
-                        // TS isn't quite smart enough here...
-                        // GERRIT this is wrong
-                        return { ...part };
-                    }
-                    else {
+                    if (typeof part.target === "number") {
                         const part2 = {
                             kind: part.kind,
                             tag: part.tag,
                             text: part.text,
+                            target: undefined,
+                            tsLinkText: part.tsLinkText,
                         };
                         links.push([part.target, part2]);
                         return part2;
                     }
+                    else if (typeof part.target === "string" ||
+                        part.target === undefined) {
+                        return {
+                            kind: "inline-tag",
+                            tag: part.tag,
+                            text: part.text,
+                            target: part.target,
+                            tsLinkText: part.tsLinkText,
+                        };
+                    }
+                    else if (typeof part.target === "object") {
+                        return {
+                            kind: "inline-tag",
+                            tag: part.tag,
+                            text: part.text,
+                            target: new ReflectionSymbolId_1.ReflectionSymbolId(part.target),
+                            tsLinkText: part.tsLinkText,
+                        };
+                    }
+                    else {
+                        (0, utils_1.assertNever)(part.target);
+                    }
                 }
             }
         });

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

@@ -40,7 +40,7 @@ export declare enum ConversionFlags {
  * kind of a reflection is stored in its ´kind´ member.
  */
 export declare class DeclarationReflection extends ContainerReflection {
-    readonly variant: "reference" | "declaration";
+    readonly variant: "declaration" | "reference";
     /**
      * A list of all source files that contributed to this reflection.
      */

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

@@ -52,12 +52,6 @@ export declare class ProjectReflection extends ContainerReflection {
      * @returns     An array containing all reflections with the desired kind.
      */
     getReflectionsByKind(kind: ReflectionKind): Reflection[];
-    /**
-     * Disassociate this project with all TypeScript created objects, allowing the underlying
-     * `ts.Program` to be garbage collected. This is very important for monorepo projects where
-     * we need to create multiple programs. See #1606 and surrounding discussion.
-     */
-    forgetTsReferences(): void;
     /**
      * Registers the given reflection so that it can be quickly looked up by helper methods.
      * Should be called for *every* reflection added to the project.

package/dist/lib/models/reflections/project.js

@@ -49,22 +49,6 @@ class ProjectReflection extends container_1.ContainerReflection {
     getReflectionsByKind(kind) {
         return Object.values(this.reflections).filter((reflection) => reflection.kindOf(kind));
     }
-    /**
-     * Disassociate this project with all TypeScript created objects, allowing the underlying
-     * `ts.Program` to be garbage collected. This is very important for monorepo projects where
-     * we need to create multiple programs. See #1606 and surrounding discussion.
-     */
-    forgetTsReferences() {
-        // Clear ts.Symbol references
-        this.reflectionIdToSymbolMap.clear();
-        // TODO: I think we need to do something like this.
-        // Update local references
-        this.symbolToReflectionIdMap.clear();
-        for (const [k, v] of this.reflectionIdToSymbolIdMap) {
-            v.pos = Infinity;
-            this.symbolToReflectionIdMap.set(v, k);
-        }
-    }
     /**
      * Registers the given reflection so that it can be quickly looked up by helper methods.
      * Should be called for *every* reflection added to the project.

package/dist/lib/models/types.js

@@ -24,11 +24,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnknownType = exports.UnionType = exports.TypeOperatorType = exports.NamedTupleMember = exports.TupleType = exports.TemplateLiteralType = exports.RestType = exports.ReflectionType = exports.ReferenceType = exports.QueryType = exports.PredicateType = exports.OptionalType = exports.MappedType = exports.LiteralType = exports.IntrinsicType = exports.IntersectionType = exports.InferredType = exports.IndexedAccessType = exports.ConditionalType = exports.ArrayType = exports.TypeContext = exports.makeRecursiveVisitor = exports.Type = void 0;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
 const ts = __importStar(require("typescript"));
 const tsutils_1 = require("../utils/tsutils");
 const ReflectionSymbolId_1 = require("./reflections/ReflectionSymbolId");
+const fs_1 = require("../utils/fs");
 /**
  * Base class of all type definitions.
  */
@@ -740,7 +739,7 @@ class ReferenceType extends Type {
             return ref;
         }
         // Otherwise, look for a "package.json" file in a parent path
-        ref.package = findPackageForPath(symbolPath);
+        ref.package = (0, fs_1.findPackageForPath)(symbolPath);
         return ref;
     }
     /** @internal this is used for type parameters, which don't actually point to something */
@@ -1134,31 +1133,3 @@ class UnknownType extends Type {
     }
 }
 exports.UnknownType = UnknownType;
-const packageJsonLookupCache = {};
-function findPackageForPath(sourcePath) {
-    if (packageJsonLookupCache[sourcePath] !== undefined) {
-        return packageJsonLookupCache[sourcePath];
-    }
-    let basePath = sourcePath;
-    for (;;) {
-        const nextPath = path.dirname(basePath);
-        if (nextPath === basePath) {
-            return;
-        }
-        basePath = nextPath;
-        const projectPath = path.join(basePath, "package.json");
-        try {
-            const packageJsonData = fs.readFileSync(projectPath, {
-                encoding: "utf8",
-            });
-            const packageJson = JSON.parse(packageJsonData);
-            if (packageJson.name !== undefined) {
-                packageJsonLookupCache[sourcePath] = packageJson.name;
-            }
-            return packageJson.name;
-        }
-        catch (err) {
-            continue;
-        }
-    }
-}

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

@@ -1,5 +1,5 @@
 import { Component, AbstractComponent } from "../utils/component";
-import { ProjectReflection, DeclarationReflection } from "../models/reflections/index";
+import type { ProjectReflection, Reflection } from "../models/reflections/index";
 import type { Renderer } from "./renderer";
 import { RendererEvent, PageEvent } from "./events";
 export { Component };
@@ -16,7 +16,7 @@ export declare abstract class ContextAwareRendererComponent extends RendererComp
     /**
      * The reflection that is currently processed.
      */
-    protected reflection?: DeclarationReflection;
+    protected page?: PageEvent<Reflection>;
     /**
      * The url of the document that is being currently generated.
      * Set when a page begins rendering.
@@ -50,5 +50,5 @@ export declare abstract class ContextAwareRendererComponent extends RendererComp
      *
      * @param page  An event object describing the current render operation.
      */
-    protected onBeginPage(page: PageEvent): void;
+    protected onBeginPage(page: PageEvent<Reflection>): void;
 }

package/dist/lib/output/components.js

@@ -27,7 +27,6 @@ exports.ContextAwareRendererComponent = exports.RendererComponent = exports.Comp
 const Path = __importStar(require("path"));
 const component_1 = require("../utils/component");
 Object.defineProperty(exports, "Component", { enumerable: true, get: function () { return component_1.Component; } });
-const index_1 = require("../models/reflections/index");
 const events_1 = require("./events");
 class RendererComponent extends component_1.AbstractComponent {
 }
@@ -84,10 +83,7 @@ class ContextAwareRendererComponent extends RendererComponent {
      */
     onBeginPage(page) {
         this.location = page.url;
-        this.reflection =
-            page.model instanceof index_1.DeclarationReflection
-                ? page.model
-                : undefined;
+        this.page = page;
     }
 }
 exports.ContextAwareRendererComponent = ContextAwareRendererComponent;

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

@@ -1,7 +1,7 @@
 import { Event } from "../utils/events";
 import type { ProjectReflection } from "../models/reflections/project";
 import type { RenderTemplate, UrlMapping } from "./models/UrlMapping";
-import type { DeclarationReflection } from "../models";
+import type { DeclarationReflection, ReflectionKind } from "../models";
 /**
  * An event emitted by the {@link Renderer} class at the very beginning and
  * ending of the entire rendering process.
@@ -42,7 +42,7 @@ export declare class RendererEvent extends Event {
      * @param mapping  The mapping that defines the generated {@link PageEvent} state.
      * @returns A newly created {@link PageEvent} instance.
      */
-    createPageEvent<Model>(mapping: UrlMapping<Model>): PageEvent<Model>;
+    createPageEvent<Model>(mapping: UrlMapping<Model>): [RenderTemplate<PageEvent<Model>>, PageEvent<Model>];
 }
 /**
  * An event emitted by the {@link Renderer} class before and after the
@@ -51,7 +51,7 @@ export declare class RendererEvent extends Event {
  * @see {@link Renderer.EVENT_BEGIN_PAGE}
  * @see {@link Renderer.EVENT_END_PAGE}
  */
-export declare class PageEvent<Model = unknown> extends Event {
+export declare class PageEvent<out Model = unknown> extends Event {
     /**
      * The project the renderer is currently processing.
      */
@@ -67,17 +67,24 @@ export declare class PageEvent<Model = unknown> extends Event {
     /**
      * The model that should be rendered on this page.
      */
-    model: Model;
-    /**
-     * The template that should be used to render this page.
-     */
-    template: RenderTemplate<this>;
+    readonly model: Model;
     /**
      * The final html content of this page.
      *
      * Should be rendered by layout templates and can be modified by plugins.
      */
     contents?: string;
+    /**
+     * Links to content within this page that should be rendered in the page navigation.
+     * This is built when rendering the document content.
+     */
+    pageHeadings: Array<{
+        link: string;
+        text: string;
+        level?: number;
+        kind?: ReflectionKind;
+        classes?: string;
+    }>;
     /**
      * Triggered before a document will be rendered.
      * @event
@@ -88,11 +95,12 @@ export declare class PageEvent<Model = unknown> extends Event {
      * @event
      */
     static readonly END = "endPage";
+    constructor(name: string, model: Model);
 }
 /**
  * An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.
  *
- * @see {@link PARSE}
+ * @see {@link MarkdownEvent.PARSE}
  */
 export declare class MarkdownEvent extends Event {
     /**
@@ -103,12 +111,16 @@ export declare class MarkdownEvent extends Event {
      * The parsed output.
      */
     parsedText: string;
+    /**
+     * The page that this markdown is being parsed for.
+     */
+    readonly page: PageEvent;
     /**
      * Triggered on the renderer when this plugin parses a markdown string.
      * @event
      */
     static readonly PARSE = "parseMarkdown";
-    constructor(name: string, originalText: string, parsedText: string);
+    constructor(name: string, page: PageEvent, originalText: string, parsedText: string);
 }
 /**
  * An event emitted when the search index is being prepared.