typedoc 0.26.4 → 0.26.6

package/dist/index.d.ts

@@ -20,7 +20,7 @@ export * from "./lib/models";
 export { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, type ExternalResolveResult, type ExternalSymbolResolver, type ConverterEvents, } from "./lib/converter";
 export { Renderer, DefaultTheme, DefaultThemeRenderContext, Slugger, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
 export type { RenderTemplate, RendererHooks, NavigationElement, RendererEvents, PageHeading, } from "./lib/output";
-export { ArgumentsReader, Option, CommentStyle, JSX, LogLevel, Logger, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } from "./lib/utils";
+export { ArgumentsReader, Option, CommentStyle, JSX, LogLevel, Logger, Options, OptionDefaults, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } 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, EnumKeys, JsDocCompatibility, } from "./lib/utils";
 export { JSONOutput, Serializer, type SerializerEvents, Deserializer, type Deserializable, type DeserializerComponent, type SerializerComponent, SerializeEvent, } from "./lib/serialization";
 export * as Internationalization from "./lib/internationalization/index";

package/dist/index.js

@@ -29,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.Internationalization = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = 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.Option = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.Slugger = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Configuration = exports.Models = exports.resetReflectionID = exports.EventDispatcher = exports.Application = void 0;
+exports.TypeScript = exports.Internationalization = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.OptionDefaults = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.Slugger = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Configuration = exports.Models = exports.resetReflectionID = 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");
@@ -74,6 +74,7 @@ Object.defineProperty(exports, "JSX", { enumerable: true, get: function () { ret
 Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return utils_1.LogLevel; } });
 Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return utils_1.Logger; } });
 Object.defineProperty(exports, "Options", { enumerable: true, get: function () { return utils_1.Options; } });
+Object.defineProperty(exports, "OptionDefaults", { enumerable: true, get: function () { return utils_1.OptionDefaults; } });
 Object.defineProperty(exports, "PackageJsonReader", { enumerable: true, get: function () { return utils_1.PackageJsonReader; } });
 Object.defineProperty(exports, "ParameterHint", { enumerable: true, get: function () { return utils_1.ParameterHint; } });
 Object.defineProperty(exports, "ParameterType", { enumerable: true, get: function () { return utils_1.ParameterType; } });

package/dist/lib/application.js

@@ -96,12 +96,11 @@ const links_1 = require("./validation/links");
 const application_events_1 = require("./application-events");
 const tsconfig_1 = require("./utils/tsconfig");
 const fs_1 = require("./utils/fs");
-const abstract_1 = require("./models/reflections/abstract");
 const ReflectionSymbolId_1 = require("./models/reflections/ReflectionSymbolId");
 const internationalization_1 = require("./internationalization/internationalization");
 const highlighter_1 = require("./utils/highlighter");
 const FileRegistry_1 = require("./models/FileRegistry");
-// eslint-disable-next-line @typescript-eslint/no-var-requires
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 const packageInfo = require("../../package.json");
 const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
     .split("||")
@@ -535,12 +534,12 @@ let Application = (() => {
                     projects.push(serialized);
                 }
                 // When debugging memory issues, it's useful to set these
-                // here so that a breakpoint on resetReflectionID below
+                // here so that a breakpoint on the continue statement below
                 // gets the memory as it ought to be with all TS objects released.
                 project = undefined;
                 this.files = undefined;
                 // global.gc!();
-                (0, abstract_1.resetReflectionID)();
+                continue;
             }
             this.options = origOptions;
             this.files = origFiles;

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

@@ -308,6 +308,11 @@ function declarationToCommentNodeIgnoringParents(node) {
     // ts.SourceFile is a counterexample
     if (!node.parent)
         return node;
+    // function foo(x: number)
+    //              ^^^^^^^^^
+    if (node.kind === typescript_1.default.SyntaxKind.Parameter) {
+        return node;
+    }
     // const abc = 123
     //       ^^^
     if (node.parent.kind === typescript_1.default.SyntaxKind.VariableDeclarationList) {

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

@@ -34,6 +34,7 @@ const lexer_1 = require("./lexer");
 const tagName_1 = require("./tagName");
 const FileRegistry_1 = require("../../models/FileRegistry");
 const textParser_1 = require("./textParser");
+const fs_1 = require("../../utils/fs");
 function makeLookaheadGenerator(gen) {
     let trackHistory = false;
     const history = [];
@@ -80,7 +81,7 @@ function parseComment(tokens, config, file, logger, files) {
     return comment;
     function warningImpl(message, token) {
         if (config.suppressCommentWarningsInDeclarationFiles &&
-            file.fileName.endsWith(".d.ts")) {
+            (0, fs_1.hasDeclarationFileExtension)(file.fileName)) {
             return;
         }
         logger.warn(message, token.pos, file);
@@ -140,8 +141,8 @@ function parseCommentString(tokens, config, file, logger, files) {
     }
     // Check for frontmatter
     let frontmatterData = {};
-    const firstBlock = content[0];
-    if (firstBlock.text.startsWith("---\n")) {
+    const firstBlock = content.at(0);
+    if (firstBlock?.text.startsWith("---\n")) {
         const end = firstBlock.text.indexOf("\n---\n");
         if (end !== -1) {
             const yamlText = firstBlock.text.slice("---\n".length, end);

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

@@ -6,6 +6,7 @@ import { ConverterComponent } from "../components";
 export declare class ImplementsPlugin extends ConverterComponent {
     private resolved;
     private postponed;
+    private revivingSerialized;
     /**
      * Create a new ImplementsPlugin instance.
      */
@@ -16,6 +17,7 @@ export declare class ImplementsPlugin extends ConverterComponent {
     private analyzeImplements;
     private analyzeInheritance;
     private onResolveEnd;
+    private onRevive;
     private resolve;
     private tryResolve;
     private doResolve;
@@ -28,4 +30,14 @@ export declare class ImplementsPlugin extends ConverterComponent {
      * during the resolve step with links which actually point to the right place.
      */
     private onDeclaration;
+    /**
+     * Responsible for copying comments from "parent" reflections defined
+     * in either a base class or implemented interface to the child class.
+     */
+    private handleInheritedComments;
+    /**
+     * Copy the comment of the source reflection to the target reflection with a JSDoc style copy
+     * function. The TSDoc copy function is in the InheritDocPlugin.
+     */
+    private copyComment;
 }

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

@@ -65,6 +65,7 @@ let ImplementsPlugin = (() => {
             super(...arguments);
             this.resolved = new WeakSet();
             this.postponed = new WeakMap();
+            this.revivingSerialized = false;
         }
         /**
          * Create a new ImplementsPlugin instance.
@@ -73,13 +74,13 @@ let ImplementsPlugin = (() => {
             this.owner.on(converter_1.Converter.EVENT_RESOLVE_END, this.onResolveEnd.bind(this));
             this.owner.on(converter_1.Converter.EVENT_CREATE_DECLARATION, this.onDeclaration.bind(this), -1000);
             this.owner.on(converter_1.Converter.EVENT_CREATE_SIGNATURE, this.onSignature.bind(this), 1000);
-            this.application.on(application_events_1.ApplicationEvents.REVIVE, this.resolve.bind(this));
+            this.application.on(application_events_1.ApplicationEvents.REVIVE, this.onRevive.bind(this));
         }
         /**
          * Mark all members of the given class to be the implementation of the matching interface member.
          */
         analyzeImplements(project, classReflection, interfaceReflection) {
-            handleInheritedComments(classReflection, interfaceReflection);
+            this.handleInheritedComments(classReflection, interfaceReflection);
             if (!interfaceReflection.children) {
                 return;
             }
@@ -110,7 +111,7 @@ let ImplementsPlugin = (() => {
                         }
                     }
                 }
-                handleInheritedComments(classMember, interfaceMember);
+                this.handleInheritedComments(classMember, interfaceMember);
             });
         }
         analyzeInheritance(project, reflection) {
@@ -121,7 +122,7 @@ let ImplementsPlugin = (() => {
                     : void 0;
             });
             for (const parent of extendedTypes) {
-                handleInheritedComments(reflection, parent.reflection);
+                this.handleInheritedComments(reflection, parent.reflection);
                 for (const parentMember of parent.reflection.children ?? []) {
                     const child = findMatchingMember(parentMember, reflection);
                     if (child) {
@@ -132,7 +133,7 @@ let ImplementsPlugin = (() => {
                             childSig[key] = types_1.ReferenceType.createResolvedReference(`${parent.name}.${parentMember.name}`, parentSig, project);
                         }
                         child[key] = types_1.ReferenceType.createResolvedReference(`${parent.name}.${parentMember.name}`, parentMember, project);
-                        handleInheritedComments(child, parentMember);
+                        this.handleInheritedComments(child, parentMember);
                     }
                 }
             }
@@ -140,6 +141,11 @@ let ImplementsPlugin = (() => {
         onResolveEnd(context) {
             this.resolve(context.project);
         }
+        onRevive(project) {
+            this.revivingSerialized = true;
+            this.resolve(project);
+            this.revivingSerialized = false;
+        }
         resolve(project) {
             for (const id in project.reflections) {
                 const refl = project.reflections[id];
@@ -262,6 +268,73 @@ let ImplementsPlugin = (() => {
                 }
             }
         }
+        /**
+         * Responsible for copying comments from "parent" reflections defined
+         * in either a base class or implemented interface to the child class.
+         */
+        handleInheritedComments(child, parent) {
+            this.copyComment(child, parent);
+            if (parent.kindOf(index_1.ReflectionKind.Property) &&
+                child.kindOf(index_1.ReflectionKind.Accessor)) {
+                if (child.getSignature) {
+                    this.copyComment(child.getSignature, parent);
+                    child.getSignature.implementationOf = child.implementationOf;
+                }
+                if (child.setSignature) {
+                    this.copyComment(child.setSignature, parent);
+                    child.setSignature.implementationOf = child.implementationOf;
+                }
+            }
+            if (parent.kindOf(index_1.ReflectionKind.Accessor) &&
+                child.kindOf(index_1.ReflectionKind.Accessor)) {
+                if (parent.getSignature && child.getSignature) {
+                    this.copyComment(child.getSignature, parent.getSignature);
+                }
+                if (parent.setSignature && child.setSignature) {
+                    this.copyComment(child.setSignature, parent.setSignature);
+                }
+            }
+            if (parent.kindOf(index_1.ReflectionKind.FunctionOrMethod) &&
+                parent.signatures &&
+                child.signatures) {
+                for (const [cs, ps] of (0, array_1.zip)(child.signatures, parent.signatures)) {
+                    this.copyComment(cs, ps);
+                }
+            }
+            else if (parent.kindOf(index_1.ReflectionKind.Property) &&
+                parent.type instanceof types_1.ReflectionType &&
+                parent.type.declaration.signatures &&
+                child.signatures) {
+                for (const [cs, ps] of (0, array_1.zip)(child.signatures, parent.type.declaration.signatures)) {
+                    this.copyComment(cs, ps);
+                }
+            }
+        }
+        /**
+         * Copy the comment of the source reflection to the target reflection with a JSDoc style copy
+         * function. The TSDoc copy function is in the InheritDocPlugin.
+         */
+        copyComment(target, source) {
+            if (!shouldCopyComment(target, source, this.revivingSerialized)) {
+                return;
+            }
+            target.comment = source.comment.clone();
+            if (target instanceof index_1.DeclarationReflection &&
+                source instanceof index_1.DeclarationReflection) {
+                for (const [tt, ts] of (0, array_1.zip)(target.typeParameters || [], source.typeParameters || [])) {
+                    this.copyComment(tt, ts);
+                }
+            }
+            if (target instanceof index_1.SignatureReflection &&
+                source instanceof index_1.SignatureReflection) {
+                for (const [tt, ts] of (0, array_1.zip)(target.typeParameters || [], source.typeParameters || [])) {
+                    this.copyComment(tt, ts);
+                }
+                for (const [pt, ps] of (0, array_1.zip)(target.parameters || [], source.parameters || [])) {
+                    this.copyComment(pt, ps);
+                }
+            }
+        }
     };
     __setFunctionName(_classThis, "ImplementsPlugin");
     (() => {
@@ -305,7 +378,9 @@ function createLink(context, reflection, clause, expr, symbol, isInherit) {
         link(sig);
     }
     // Intentionally create broken links here. These will be replaced with real links during
-    // resolution if we can do so.
+    // resolution if we can do so. We create broken links rather than real links because in the
+    // case of an inherited symbol, we'll end up referencing a single symbol ID rather than one
+    // for each class.
     function link(target) {
         if (!target)
             return;
@@ -322,79 +397,23 @@ function createLink(context, reflection, clause, expr, symbol, isInherit) {
         }
     }
 }
-/**
- * Responsible for copying comments from "parent" reflections defined
- * in either a base class or implemented interface to the child class.
- */
-function handleInheritedComments(child, parent) {
-    copyComment(child, parent);
-    if (parent.kindOf(index_1.ReflectionKind.Property) &&
-        child.kindOf(index_1.ReflectionKind.Accessor)) {
-        if (child.getSignature) {
-            copyComment(child.getSignature, parent);
-            child.getSignature.implementationOf = child.implementationOf;
-        }
-        if (child.setSignature) {
-            copyComment(child.setSignature, parent);
-            child.setSignature.implementationOf = child.implementationOf;
-        }
-    }
-    if (parent.kindOf(index_1.ReflectionKind.Accessor) &&
-        child.kindOf(index_1.ReflectionKind.Accessor)) {
-        if (parent.getSignature && child.getSignature) {
-            copyComment(child.getSignature, parent.getSignature);
-        }
-        if (parent.setSignature && child.setSignature) {
-            copyComment(child.setSignature, parent.setSignature);
-        }
-    }
-    if (parent.kindOf(index_1.ReflectionKind.FunctionOrMethod) &&
-        parent.signatures &&
-        child.signatures) {
-        for (const [cs, ps] of (0, array_1.zip)(child.signatures, parent.signatures)) {
-            copyComment(cs, ps);
-        }
-    }
-    else if (parent.kindOf(index_1.ReflectionKind.Property) &&
-        parent.type instanceof types_1.ReflectionType &&
-        parent.type.declaration.signatures &&
-        child.signatures) {
-        for (const [cs, ps] of (0, array_1.zip)(child.signatures, parent.type.declaration.signatures)) {
-            copyComment(cs, ps);
-        }
+function shouldCopyComment(target, source, revivingSerialized) {
+    if (!source.comment) {
+        return false;
     }
-}
-/**
- * Copy the comment of the source reflection to the target reflection with a JSDoc style copy
- * function. The TSDoc copy function is in the InheritDocPlugin.
- */
-function copyComment(target, source) {
     if (target.comment) {
+        // If we're reviving, then the revived project might have a better comment
+        // on source, so copy it.
+        if (revivingSerialized && source.comment.similarTo(target.comment)) {
+            return true;
+        }
         // We might still want to copy, if the child has a JSDoc style inheritDoc tag.
         const tag = target.comment.getTag("@inheritDoc");
         if (!tag || tag.name) {
-            return;
-        }
-    }
-    if (!source.comment) {
-        return;
-    }
-    target.comment = source.comment.clone();
-    if (target instanceof index_1.DeclarationReflection &&
-        source instanceof index_1.DeclarationReflection) {
-        for (const [tt, ts] of (0, array_1.zip)(target.typeParameters || [], source.typeParameters || [])) {
-            copyComment(tt, ts);
-        }
-    }
-    if (target instanceof index_1.SignatureReflection &&
-        source instanceof index_1.SignatureReflection) {
-        for (const [tt, ts] of (0, array_1.zip)(target.typeParameters || [], source.typeParameters || [])) {
-            copyComment(tt, ts);
-        }
-        for (const [pt, ps] of (0, array_1.zip)(target.parameters || [], source.parameters || [])) {
-            copyComment(pt, ps);
+            return false;
         }
     }
+    return true;
 }
 function findMatchingMember(toMatch, container) {
     return container.children?.find((child) => child.name == toMatch.name &&

package/dist/lib/internationalization/internationalization.js

@@ -31,7 +31,7 @@ class Internationalization {
             (0, assert_1.ok)(/^[A-Za-z-]+$/.test(lang), "Locale names may only contain letters and dashes");
             try {
                 return new Map(
-                // eslint-disable-next-line @typescript-eslint/no-var-requires
+                // eslint-disable-next-line @typescript-eslint/no-require-imports
                 Object.entries(require(`./locales/${lang}.${ext}`)));
             }
             catch {

package/dist/lib/internationalization/translatable.js

@@ -356,9 +356,7 @@ exports.translatable = {
 // Compiler errors here which says a property is missing indicates that the value on translatable
 // is not a literal string. It should be so that TypeDoc's placeholder replacement detection
 // can validate that all placeholders have been specified.
-const _validateLiteralStrings = {};
-_validateLiteralStrings;
+({});
 // Compiler errors here which says a property is missing indicates that the key on translatable
 // contains a placeholder _0/_1, etc. but the value does not match the expected constraint.
-const _validatePlaceholdersPresent = exports.translatable;
-_validatePlaceholdersPresent;
+exports.translatable;

package/dist/lib/models/FileRegistry.js

@@ -85,7 +85,11 @@ class FileRegistry {
             result.entries[key] = (0, utils_1.normalizePath)((0, path_1.relative)(ser.projectRoot, val));
         }
         for (const [key, val] of this.mediaToReflection.entries()) {
-            result.reflections[key] = val.id;
+            // A registry may be shared by multiple projects. When serializing,
+            // only save reflection mapping for reflections in the serialized project.
+            if (ser.project.getReflectionById(val.id)) {
+                result.reflections[key] = val.id;
+            }
         }
         return result;
     }

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

@@ -93,6 +93,12 @@ export declare class CommentTag {
      * Create a new CommentTag instance.
      */
     constructor(tag: `@${string}`, text: CommentDisplayPart[]);
+    /**
+     * Checks if this block tag is roughly equal to the other tag.
+     * This isn't exactly equal, but just "roughly equal" by the tag
+     * text.
+     */
+    similarTo(other: CommentTag): boolean;
     clone(): CommentTag;
     toObject(serializer: Serializer): JSONOutput.CommentTag;
     fromObject(de: Deserializer, obj: JSONOutput.CommentTag): void;
@@ -191,6 +197,12 @@ export declare class Comment {
      * Creates a new Comment instance.
      */
     constructor(summary?: CommentDisplayPart[], blockTags?: CommentTag[], modifierTags?: Set<`@${string}`>);
+    /**
+     * Checks if this comment is roughly equal to the other comment.
+     * This isn't exactly equal, but just "roughly equal" by the comment
+     * text.
+     */
+    similarTo(other: Comment): boolean;
     /**
      * Create a deep clone of this comment.
      */

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

@@ -58,6 +58,17 @@ class CommentTag {
         this.tag = tag;
         this.content = text;
     }
+    /**
+     * Checks if this block tag is roughly equal to the other tag.
+     * This isn't exactly equal, but just "roughly equal" by the tag
+     * text.
+     */
+    similarTo(other) {
+        return (this.tag === other.tag &&
+            this.name === other.tag &&
+            Comment.combineDisplayParts(this.content) ===
+                Comment.combineDisplayParts(other.content));
+    }
     clone() {
         const tag = new CommentTag(this.tag, Comment.cloneDisplayParts(this.content));
         if (this.name) {
@@ -317,6 +328,28 @@ let Comment = (() => {
                 this.modifierTags = modifierTags;
                 extractLabelTag(this);
             }
+            /**
+             * Checks if this comment is roughly equal to the other comment.
+             * This isn't exactly equal, but just "roughly equal" by the comment
+             * text.
+             */
+            similarTo(other) {
+                if (_a.combineDisplayParts(this.summary) !==
+                    _a.combineDisplayParts(other.summary)) {
+                    return false;
+                }
+                // Ignore modifier tags, as they could cause false negatives
+                // if a cascaded modifier tag is present in one comment but not the other.
+                if (this.blockTags.length !== other.blockTags.length) {
+                    return false;
+                }
+                for (let i = 0; i < this.blockTags.length; ++i) {
+                    if (!this.blockTags[i].similarTo(other.blockTags[i])) {
+                        return false;
+                    }
+                }
+                return true;
+            }
             /**
              * Create a deep clone of this comment.
              */

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

@@ -1,5 +1,6 @@
 import { type Reflection } from "./abstract";
 import { ContainerReflection } from "./container";
+import { type Type } from "../types";
 import type * as ts from "typescript";
 import { ReflectionKind } from "./kind";
 import { type CommentDisplayPart } from "../comments";
@@ -64,6 +65,13 @@ export declare class ProjectReflection extends ContainerReflection {
      * Should be called for *every* reflection added to the project.
      */
     registerReflection(reflection: Reflection, symbol: ts.Symbol | undefined, filePath: string | undefined): void;
+    /**
+     * Removes references to reflections contained within the provided type.
+     * Plugins which overwrite types on reflections should pass the type to this
+     * method before overwriting the property.
+     * @since 0.26.6
+     */
+    removeTypeReflections(type: Type | undefined): void;
     /**
      * Removes a reflection from the documentation. Can be used by plugins to filter reflections
      * out of the generated documentation. Has no effect if the reflection is not present in the

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

@@ -34,7 +34,7 @@ class ProjectReflection extends container_1.ContainerReflection {
          *
          * This may be replaced with a `Map<number, Reflection>` someday.
          */
-        this.reflections = {};
+        this.reflections = { [this.id]: this };
         this.reflections[this.id] = this;
         this.files = registry;
     }
@@ -92,6 +92,19 @@ class ProjectReflection extends container_1.ContainerReflection {
             this.files.registerReflection(filePath, reflection);
         }
     }
+    /**
+     * Removes references to reflections contained within the provided type.
+     * Plugins which overwrite types on reflections should pass the type to this
+     * method before overwriting the property.
+     * @since 0.26.6
+     */
+    removeTypeReflections(type) {
+        type?.visit((0, types_1.makeRecursiveVisitor)({
+            reflection: (type) => {
+                this.removeReflection(type.declaration);
+            },
+        }));
+    }
     /**
      * Removes a reflection from the documentation. Can be used by plugins to filter reflections
      * out of the generated documentation. Has no effect if the reflection is not present in the

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

@@ -180,10 +180,12 @@ let JavascriptIndexPlugin = (() => {
                 comments.push(reflection.comment);
             if (reflection.isDeclaration()) {
                 reflection.signatures?.forEach((s) => s.comment && comments.push(s.comment));
-                reflection.getSignature?.comment &&
+                if (reflection.getSignature?.comment) {
                     comments.push(reflection.getSignature.comment);
-                reflection.setSignature?.comment &&
+                }
+                if (reflection.setSignature?.comment) {
                     comments.push(reflection.setSignature.comment);
+                }
             }
             if (!comments.length) {
                 return;

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

@@ -258,9 +258,6 @@ class DefaultTheme extends theme_1.Theme {
                     children,
                 };
             }
-            if (!element.hasOwnDocument) {
-                return;
-            }
             return {
                 text: (0, lib_1.getDisplayName)(element),
                 path: element.url,
@@ -294,16 +291,26 @@ class DefaultTheme extends theme_1.Theme {
                 return (0, utils_1.filterMap)(parent.documents, toNavigation);
             }
             if (parent.categories && shouldShowCategories(parent, opts)) {
-                return (0, utils_1.filterMap)(parent.categories, toNavigation);
+                return filterMapWithNoneCollection(parent.categories);
             }
             if (parent.groups && shouldShowGroups(parent, opts)) {
-                return (0, utils_1.filterMap)(parent.groups, toNavigation);
+                return filterMapWithNoneCollection(parent.groups);
             }
             if (opts.includeFolders && parent.childrenIncludingDocuments?.some((child) => child.name.includes("/"))) {
                 return deriveModuleFolders(parent.childrenIncludingDocuments);
             }
             return (0, utils_1.filterMap)(parent.childrenIncludingDocuments, toNavigation);
         }
+        function filterMapWithNoneCollection(reflection) {
+            const none = reflection.find((x) => x.title.toLocaleLowerCase() === "none");
+            const others = reflection.filter((x) => x.title.toLocaleLowerCase() !== "none");
+            const mappedOthers = (0, utils_1.filterMap)(others, toNavigation);
+            if (none) {
+                const noneMappedChildren = (0, utils_1.filterMap)(none.children, toNavigation);
+                return [...noneMappedChildren, ...mappedOthers];
+            }
+            return mappedOthers;
+        }
         function deriveModuleFolders(children) {
             const result = [];
             const resolveOrCreateParents = (path, root = result) => {
@@ -336,19 +343,21 @@ class DefaultTheme extends theme_1.Theme {
             }
             // Now merge single-possible-paths together so we don't have folders in our navigation
             // which contain only another single folder.
-            const queue = [...result];
-            while (queue.length) {
-                const review = queue.shift();
-                queue.push(...(review.children || []));
-                if (review.kind || review.path)
-                    continue;
-                if (review.children?.length === 1) {
-                    const copyFrom = review.children[0];
-                    const fullName = `${review.text}/${copyFrom.text}`;
-                    delete review.children;
-                    Object.assign(review, copyFrom);
-                    review.text = fullName;
-                    queue.push(review);
+            if (opts.compactFolders) {
+                const queue = [...result];
+                while (queue.length) {
+                    const review = queue.shift();
+                    queue.push(...(review.children || []));
+                    if (review.kind || review.path)
+                        continue;
+                    if (review.children?.length === 1) {
+                        const copyFrom = review.children[0];
+                        const fullName = `${review.text}/${copyFrom.text}`;
+                        delete review.children;
+                        Object.assign(review, copyFrom);
+                        review.text = fullName;
+                        queue.push(review);
+                    }
                 }
             }
             return result;

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

@@ -9,7 +9,7 @@ import type { ModelToObject } from "./schema";
  * Additionally, each {@link Serializer} plugin must define a predicate that instructs the group
  * it belongs to.
  */
-export interface SerializerComponent<T extends {}> {
+export interface SerializerComponent<T extends object> {
     /**
      * The priority this serializer should be executed with.
      * A higher priority means the {@link Serializer} will be applied earlier.

package/dist/lib/serialization/deserializer.js

@@ -118,7 +118,6 @@ class Deserializer {
     reviveProject(projectObj, name, projectRoot, registry) {
         (0, assert_1.ok)(this.deferred.length === 0, "Deserializer.defer was called when not deserializing");
         const project = new index_1.ProjectReflection(name || projectObj.name, registry);
-        project.registerReflection(project, undefined, undefined);
         this.project = project;
         this.projectRoot = projectRoot;
         this.oldIdToNewId = { [projectObj.id]: project.id };

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

@@ -23,7 +23,11 @@ export declare class Serializer extends EventDispatcher<SerializerEvents> {
      * Only set when serializing.
      */
     projectRoot: string;
-    addSerializer<T extends {}>(serializer: SerializerComponent<T>): void;
+    /**
+     * Only set when serializing
+     */
+    project: ProjectReflection;
+    addSerializer<T extends object>(serializer: SerializerComponent<T>): void;
     toObject<T extends {
         toObject(serializer: Serializer): ModelToObject<T>;
     }>(value: T): ModelToObject<T>;