typedoc 0.25.3 → 0.25.4

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

@@ -9,20 +9,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseDeclarationReference = exports.parseMeaning = exports.parseComponentPath = exports.parseComponent = exports.parseSymbolReference = exports.parseModuleSource = exports.parseString = exports.MeaningKeywords = void 0;
 exports.MeaningKeywords = [
-    "class",
-    "interface",
-    "type",
-    "enum",
-    "namespace",
-    "function",
-    "var",
-    "constructor",
-    "member",
-    "event",
-    "call",
-    "new",
-    "index",
-    "complex",
+    "class", // SymbolFlags.Class
+    "interface", // SymbolFlags.Interface
+    "type", // SymbolFlags.TypeAlias
+    "enum", // SymbolFlags.Enum
+    "namespace", // SymbolFlags.Module
+    "function", // SymbolFlags.Function
+    "var", // SymbolFlags.Variable
+    "constructor", // SymbolFlags.Constructor
+    "member", // SymbolFlags.ClassMember | SymbolFlags.EnumMember
+    "event", //
+    "call", // SymbolFlags.Signature (for __call)
+    "new", // SymbolFlags.Signature (for __new)
+    "index", // SymbolFlags.Signature (for __index)
+    "complex", // Any complex type
     // TypeDoc specific
     "getter",
     "setter",

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

@@ -121,13 +121,15 @@ function discoverComment(symbol, kind, logger, commentStyle) {
     // not the last one, since that will apply to the import or declaration.
     const reverse = !symbol.declarations?.some(typescript_1.default.isSourceFile);
     const discovered = [];
+    const seen = new Set();
     for (const decl of symbol.declarations || []) {
         const text = decl.getSourceFile().text;
         if (wantedKinds[kind].includes(decl.kind)) {
             const node = declarationToCommentNode(decl);
-            if (!node) {
+            if (!node || seen.has(node)) {
                 continue;
             }
+            seen.add(node);
             // Special behavior here! We temporarily put the implementation comment
             // on the reflection which contains all the signatures. This lets us pull
             // the comment on the implementation if some signature does not have a comment.

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

@@ -126,8 +126,8 @@ 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" && config.jsDocCompatibility.exampleTag) {
-        content = exampleBlockContent(comment, lexer, config, warning);
+    if (tagName === "@example") {
+        return exampleBlock(comment, lexer, config, warning);
     }
     else if (["@default", "@defaultValue"].includes(tagName) &&
         config.jsDocCompatibility.defaultTag) {
@@ -168,14 +168,59 @@ function defaultBlockContent(comment, lexer, config, warning) {
 /**
  * The `@example` tag gets a special case because otherwise we will produce many warnings
  * about unescaped/mismatched/missing braces in legacy JSDoc comments.
+ *
+ * In TSDoc, we also want to treat the first line of the block as the example name.
  */
-function exampleBlockContent(comment, lexer, config, warning) {
+function exampleBlock(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" && part.text.startsWith("```"))) {
-        return blockContent(comment, lexer, config, warning);
+    if (!config.jsDocCompatibility.exampleTag ||
+        content.some((part) => part.kind === "code" && part.text.startsWith("```"))) {
+        let exampleName = "";
+        // First line of @example block is the example name.
+        let warnedAboutRichNameContent = false;
+        outer: while ((lexer.done() || lexer.peek()) !== end) {
+            const next = lexer.peek();
+            switch (next.kind) {
+                case lexer_1.TokenSyntaxKind.NewLine:
+                    lexer.take();
+                    break outer;
+                case lexer_1.TokenSyntaxKind.Text: {
+                    const newline = next.text.indexOf("\n");
+                    if (newline !== -1) {
+                        exampleName += next.text.substring(0, newline);
+                        next.pos += newline + 1;
+                        break outer;
+                    }
+                    else {
+                        exampleName += lexer.take().text;
+                    }
+                    break;
+                }
+                case lexer_1.TokenSyntaxKind.Code:
+                case lexer_1.TokenSyntaxKind.Tag:
+                case lexer_1.TokenSyntaxKind.TypeAnnotation:
+                case lexer_1.TokenSyntaxKind.CloseBrace:
+                case lexer_1.TokenSyntaxKind.OpenBrace:
+                    if (!warnedAboutRichNameContent) {
+                        warning("The first line of an example tag will be taken literally as" +
+                            " the example name, and should only contain text.", lexer.peek());
+                        warnedAboutRichNameContent = true;
+                    }
+                    exampleName += lexer.take().text;
+                    break;
+                default:
+                    (0, utils_1.assertNever)(next.kind);
+            }
+        }
+        const content = blockContent(comment, lexer, config, warning);
+        const tag = new models_1.CommentTag("@example", content);
+        if (exampleName.trim()) {
+            tag.name = exampleName.trim();
+        }
+        return tag;
     }
     const tokens = [];
     while ((lexer.done() || lexer.peek()) !== end) {
@@ -187,24 +232,22 @@ function exampleBlockContent(comment, lexer, config, warning) {
         .trim();
     const caption = blockText.match(/^\s*<caption>(.*?)<\/caption>\s*(\n|$)/);
     if (caption) {
-        return [
-            {
-                kind: "text",
-                text: caption[1] + "\n",
-            },
+        const tag = new models_1.CommentTag("@example", [
             {
                 kind: "code",
                 text: makeCodeBlock(blockText.slice(caption[0].length)),
             },
-        ];
+        ]);
+        tag.name = caption[1];
+        return tag;
     }
     else {
-        return [
+        return new models_1.CommentTag("@example", [
             {
                 kind: "code",
                 text: makeCodeBlock(blockText),
             },
-        ];
+        ]);
     }
 }
 function blockContent(comment, lexer, config, warning) {

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

@@ -156,7 +156,10 @@ let TypePlugin = (() => {
                 if (reflection.extendedBy) {
                     push(reflection.extendedBy);
                 }
-                reflection.typeHierarchy = root;
+                // No point setting up a hierarchy if there is no hierarchy to display
+                if (root.next) {
+                    reflection.typeHierarchy = root;
+                }
             });
         }
     };

package/dist/lib/converter/symbols.js

@@ -110,15 +110,6 @@ function convertSymbol(context, symbol, exportSymbol) {
         // { methodProperty() {} }
         flags = (0, enum_1.removeFlag)(flags, typescript_1.default.SymbolFlags.Property);
     }
-    // A default exported function with no associated variable is a property, but
-    // we should really convert it as a variable for documentation purposes
-    // export default () => {}
-    // export default 123
-    if (flags === typescript_1.default.SymbolFlags.Property &&
-        symbol.name === "default" &&
-        context.scope.kindOf(models_1.ReflectionKind.Module | models_1.ReflectionKind.Project)) {
-        flags = typescript_1.default.SymbolFlags.BlockScopedVariable;
-    }
     for (const flag of (0, enum_1.getEnumFlags)(flags ^ allConverterFlags)) {
         if (!(flag & allConverterFlags)) {
             context.logger.verbose(`Missing converter for symbol: ${symbol.name} with flag ${typescript_1.default.SymbolFlags[flag]}`);
@@ -359,8 +350,15 @@ function convertClassOrInterface(context, symbol, exportSymbol) {
     convertConstructSignatures(reflectionContext, symbol);
     // And finally, index signatures
     (0, index_signature_1.convertIndexSignature)(reflectionContext, symbol);
+    // Normally this shouldn't matter, unless someone did something with skipLibCheck off.
+    return typescript_1.default.SymbolFlags.Alias;
 }
 function convertProperty(context, symbol, exportSymbol) {
+    // This might happen if we're converting a function-module created with Object.assign
+    // or `export default () => {}`
+    if (context.scope.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
+        return convertVariable(context, symbol, exportSymbol);
+    }
     const declarations = symbol.getDeclarations() ?? [];
     // Don't do anything if we inherited this property and it is private.
     if (isInherited(context, symbol) &&
@@ -466,9 +464,10 @@ 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);
+    const type = declaration
+        ? context.checker.getTypeOfSymbolAtLocation(symbol, declaration)
+        : context.checker.getTypeOfSymbol(symbol);
     if (isEnumLike(context.checker, type, declaration) &&
         comment?.hasModifier("@enum")) {
         return convertVariableAsEnum(context, symbol, exportSymbol);
@@ -481,7 +480,7 @@ function convertVariable(context, symbol, exportSymbol) {
     }
     const reflection = context.createDeclarationReflection(models_1.ReflectionKind.Variable, symbol, exportSymbol);
     let typeNode;
-    if (typescript_1.default.isVariableDeclaration(declaration)) {
+    if (declaration && typescript_1.default.isVariableDeclaration(declaration)) {
         // Otherwise we might have destructuring
         typeNode = declaration.type;
     }
@@ -492,7 +491,7 @@ function convertVariable(context, symbol, exportSymbol) {
     return typescript_1.default.SymbolFlags.Property;
 }
 function isEnumLike(checker, type, location) {
-    if (!(0, enum_1.hasAllFlags)(type.flags, typescript_1.default.TypeFlags.Object)) {
+    if (!location || !(0, enum_1.hasAllFlags)(type.flags, typescript_1.default.TypeFlags.Object)) {
         return false;
     }
     return type.getProperties().every((prop) => {
@@ -545,6 +544,14 @@ function convertVariableAsFunction(context, symbol, exportSymbol) {
     for (const signature of type.getCallSignatures()) {
         (0, signature_1.createSignature)(reflectionContext, models_1.ReflectionKind.CallSignature, signature, symbol);
     }
+    // #2436: Functions created with Object.assign on a function won't have a namespace flag
+    // but likely have properties that we should put into a namespace.
+    if (type.getProperties().length &&
+        !(0, enum_1.hasAnyFlag)(symbol.flags, typescript_1.default.SymbolFlags.NamespaceModule | typescript_1.default.SymbolFlags.ValueModule)) {
+        const ns = context.createDeclarationReflection(models_1.ReflectionKind.Namespace, symbol, exportSymbol);
+        context.finalizeDeclarationReflection(ns);
+        convertSymbols(context.withScope(ns), type.getProperties());
+    }
     return typescript_1.default.SymbolFlags.Property;
 }
 function convertAccessor(context, symbol, exportSymbol) {

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

@@ -29,7 +29,7 @@ class AssumedRepository {
             path: fileName.substring(this.path.length + 1),
             line,
         };
-        return this.sourceLinkTemplate.replace(/\{(path|line)\}/g, (_, key) => replacements[key]);
+        return this.sourceLinkTemplate.replace(/\{(gitRevision|path|line)\}/g, (_, key) => replacements[key]);
     }
 }
 exports.AssumedRepository = AssumedRepository;
@@ -117,9 +117,9 @@ exports.GitRepository = GitRepository;
 // 3. project
 const repoExpressions = [
     /(github(?!.us)(?:\.[a-z]+)*\.[a-z]{2,})[:/]([^/]+)\/(.*)/,
-    /(\w+\.githubprivate.com)[:/]([^/]+)\/(.*)/,
-    /(\w+\.ghe.com)[:/]([^/]+)\/(.*)/,
-    /(\w+\.github.us)[:/]([^/]+)\/(.*)/,
+    /(\w+\.githubprivate.com)[:/]([^/]+)\/(.*)/, // GitHub enterprise
+    /(\w+\.ghe.com)[:/]([^/]+)\/(.*)/, // GitHub enterprise
+    /(\w+\.github.us)[:/]([^/]+)\/(.*)/, // GitHub enterprise
     /(bitbucket.org)[:/]([^/]+)\/(.*)/,
     /(gitlab.com)[:/]([^/]+)\/(.*)/,
 ];

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

@@ -6,8 +6,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveAliasedSymbol = void 0;
 const typescript_1 = __importDefault(require("typescript"));
 function resolveAliasedSymbol(symbol, checker) {
+    const seen = new Set();
     while (typescript_1.default.SymbolFlags.Alias & symbol.flags) {
         symbol = checker.getAliasedSymbol(symbol);
+        // #2438, with declaration files, we might have an aliased symbol which eventually points to itself.
+        if (seen.has(symbol))
+            return symbol;
+        seen.add(symbol);
     }
     return symbol;
 }

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

@@ -17,8 +17,16 @@ export declare class ReflectionSymbolId {
     /**
      * Note: This is **not** serialized. It exists for sorting by declaration order, but
      * should not be needed when deserializing from JSON.
+     * Will be set to `Infinity` if the ID was deserialized from JSON.
      */
     pos: number;
+    /**
+     * Note: This is **not** serialized. It exists to support detection of the differences between
+     * symbols which share declarations, but are instantiated with different type parameters.
+     * This will be `NaN` if the symbol reference is not transient.
+     * Note: This can only be non-NaN if {@link pos} is finite.
+     */
+    transientId: number;
     constructor(symbol: ts.Symbol, declaration?: ts.Declaration);
     constructor(json: JSONOutput.ReflectionSymbolId);
     getStableKey(): ReflectionSymbolIdString;

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

@@ -8,9 +8,11 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 const typescript_1 = __importDefault(require("typescript"));
 const fs_2 = require("../../utils/fs");
+const paths_1 = require("../../utils/paths");
 const tsutils_1 = require("../../utils/tsutils");
 const validation_1 = require("../../utils/validation");
-const paths_1 = require("../../utils/paths");
+let transientCount = 0;
+const transientIds = new WeakMap();
 /**
  * This exists so that TypeDoc can store a unique identifier for a `ts.Symbol` without
  * keeping a reference to the `ts.Symbol` itself. This identifier should be stable across
@@ -28,16 +30,24 @@ class ReflectionSymbolId {
                 this.qualifiedName = (0, tsutils_1.getQualifiedName)(symbol, symbol.name);
             }
             this.pos = declaration?.pos ?? Infinity;
+            if (symbol.flags & typescript_1.default.SymbolFlags.Transient) {
+                this.transientId = transientIds.get(symbol) ?? ++transientCount;
+                transientIds.set(symbol, this.transientId);
+            }
+            else {
+                this.transientId = NaN;
+            }
         }
         else {
             this.fileName = symbol.sourceFileName;
             this.qualifiedName = symbol.qualifiedName;
             this.pos = Infinity;
+            this.transientId = NaN;
         }
     }
     getStableKey() {
         if (Number.isFinite(this.pos)) {
-            return `${this.fileName}\0${this.qualifiedName}\0${this.pos}`;
+            return `${this.fileName}\0${this.qualifiedName}\0${this.pos}\0${this.transientId}`;
         }
         else {
             return `${this.fileName}\0${this.qualifiedName}`;
@@ -95,7 +105,7 @@ function addInferredDeclarationMapPaths(opts, files) {
     const rootDir = opts.rootDir || (0, fs_2.getCommonDirectory)(files);
     const declDir = opts.declarationDir || opts.outDir || rootDir;
     for (const file of files) {
-        const mapFile = (0, path_1.resolve)(declDir, (0, path_1.relative)(rootDir, file)).replace(/\.([cm]?[tj]s)x?$/, ".d.$1");
+        const mapFile = (0, paths_1.normalizePath)((0, path_1.resolve)(declDir, (0, path_1.relative)(rootDir, file)).replace(/\.([cm]?[tj]s)x?$/, ".d.$1"));
         declarationMapCache.set(mapFile, file);
     }
 }

package/dist/lib/models/types.js

@@ -151,27 +151,27 @@ exports.makeRecursiveVisitor = makeRecursiveVisitor;
  */
 exports.TypeContext = {
     none: "none",
-    templateLiteralElement: "templateLiteralElement",
-    arrayElement: "arrayElement",
-    indexedAccessElement: "indexedAccessElement",
-    conditionalCheck: "conditionalCheck",
-    conditionalExtends: "conditionalExtends",
-    conditionalTrue: "conditionalTrue",
-    conditionalFalse: "conditionalFalse",
-    indexedIndex: "indexedIndex",
-    indexedObject: "indexedObject",
-    inferredConstraint: "inferredConstraint",
-    intersectionElement: "intersectionElement",
-    mappedName: "mappedName",
-    mappedParameter: "mappedParameter",
-    mappedTemplate: "mappedTemplate",
-    optionalElement: "optionalElement",
-    predicateTarget: "predicateTarget",
-    queryTypeTarget: "queryTypeTarget",
-    typeOperatorTarget: "typeOperatorTarget",
-    referenceTypeArgument: "referenceTypeArgument",
-    restElement: "restElement",
-    tupleElement: "tupleElement",
+    templateLiteralElement: "templateLiteralElement", // `${here}`
+    arrayElement: "arrayElement", // here[]
+    indexedAccessElement: "indexedAccessElement", // {}[here]
+    conditionalCheck: "conditionalCheck", // here extends 1 ? 2 : 3
+    conditionalExtends: "conditionalExtends", // 1 extends here ? 2 : 3
+    conditionalTrue: "conditionalTrue", // 1 extends 2 ? here : 3
+    conditionalFalse: "conditionalFalse", // 1 extends 2 ? 3 : here
+    indexedIndex: "indexedIndex", // {}[here]
+    indexedObject: "indexedObject", // here[1]
+    inferredConstraint: "inferredConstraint", // 1 extends infer X extends here ? 1 : 2
+    intersectionElement: "intersectionElement", // here & 1
+    mappedName: "mappedName", // { [k in string as here]: 1 }
+    mappedParameter: "mappedParameter", // { [k in here]: 1 }
+    mappedTemplate: "mappedTemplate", // { [k in string]: here }
+    optionalElement: "optionalElement", // [here?]
+    predicateTarget: "predicateTarget", // (): X is here
+    queryTypeTarget: "queryTypeTarget", // typeof here, can only ever be a ReferenceType
+    typeOperatorTarget: "typeOperatorTarget", // keyof here
+    referenceTypeArgument: "referenceTypeArgument", // X<here>
+    restElement: "restElement", // [...here]
+    tupleElement: "tupleElement", // [here]
     unionElement: "unionElement", // here | 1
 };
 /**

package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts

@@ -23,6 +23,15 @@ export declare class DefaultThemeRenderContext {
     reflectionTemplate: (props: PageEvent<import("../../../models").ContainerReflection>) => JSX.Element;
     indexTemplate: (props: PageEvent<import("../../../models").ProjectReflection>) => JSX.Element;
     defaultLayout: (template: import("../..").RenderTemplate<PageEvent<Reflection>>, props: PageEvent<Reflection>) => JSX.Element;
+    /**
+     * Rendered just after the description for a reflection.
+     * This can be used to render a shortened type display of a reflection that the
+     * rest of the page expands on.
+     *
+     * Note: Will not be called for variables/type aliases, as they are summarized
+     * by their type declaration, which is already rendered by {@link DefaultThemeRenderContext.memberDeclaration}
+     */
+    reflectionPreview: (props: Reflection) => JSX.Element | undefined;
     analytics: () => JSX.Element | undefined;
     breadcrumb: (props: Reflection) => JSX.Element | undefined;
     commentSummary: (props: Reflection) => JSX.Element | undefined;
@@ -36,10 +45,10 @@ export declare class DefaultThemeRenderContext {
     memberDeclaration: (props: DeclarationReflection) => JSX.Element;
     memberGetterSetter: (props: DeclarationReflection) => JSX.Element;
     memberReference: (props: import("../../../models").ReferenceReflection) => JSX.Element;
-    memberSignatureBody: (r_0: import("../../../models").SignatureReflection, r_1?: {
+    memberSignatureBody: (props: import("../../../models").SignatureReflection, r_1?: {
         hideSources?: boolean | undefined;
     } | undefined) => JSX.Element;
-    memberSignatureTitle: (r_0: import("../../../models").SignatureReflection, r_1?: {
+    memberSignatureTitle: (props: import("../../../models").SignatureReflection, r_1?: {
         hideName?: boolean | undefined;
         arrowStyle?: boolean | undefined;
     } | undefined) => JSX.Element;
@@ -55,7 +64,9 @@ export declare class DefaultThemeRenderContext {
     pageNavigation: (props: PageEvent<Reflection>) => JSX.Element;
     parameter: (props: DeclarationReflection) => JSX.Element;
     toolbar: (props: PageEvent<Reflection>) => JSX.Element;
-    type: (type: import("../../../models").Type | undefined) => JSX.Element;
+    type: (type: import("../../../models").Type | undefined, options?: {
+        topLevelLinks: boolean;
+    } | undefined) => JSX.Element;
     typeAndParent: (props: import("../../../models").Type) => JSX.Element;
     typeParameters: (typeParameters: import("../../../models").TypeParameterReflection[]) => JSX.Element;
 }

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

@@ -23,6 +23,7 @@ const members_1 = require("./partials/members");
 const members_group_1 = require("./partials/members.group");
 const navigation_1 = require("./partials/navigation");
 const parameter_1 = require("./partials/parameter");
+const reflectionPreview_1 = require("./partials/reflectionPreview");
 const toolbar_1 = require("./partials/toolbar");
 const type_1 = require("./partials/type");
 const typeAndParent_1 = require("./partials/typeAndParent");
@@ -59,6 +60,15 @@ class DefaultThemeRenderContext {
         this.reflectionTemplate = bind(reflection_1.reflectionTemplate, this);
         this.indexTemplate = bind(templates_1.indexTemplate, this);
         this.defaultLayout = bind(default_1.defaultLayout, this);
+        /**
+         * Rendered just after the description for a reflection.
+         * This can be used to render a shortened type display of a reflection that the
+         * rest of the page expands on.
+         *
+         * Note: Will not be called for variables/type aliases, as they are summarized
+         * by their type declaration, which is already rendered by {@link DefaultThemeRenderContext.memberDeclaration}
+         */
+        this.reflectionPreview = bind(reflectionPreview_1.reflectionPreview, this);
         this.analytics = bind(analytics_1.analytics, this);
         this.breadcrumb = bind(breadcrumb_1.breadcrumb, this);
         this.commentSummary = bind(comment_1.commentSummary, this);

package/dist/lib/output/themes/default/partials/comment.js

@@ -18,9 +18,14 @@ function commentTags({ markdown }, props) {
     const tags = props.kindOf(models_1.ReflectionKind.SomeSignature)
         ? props.comment.blockTags.filter((tag) => tag.tag !== "@returns")
         : props.comment.blockTags;
-    return (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" }, tags.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        utils_1.JSX.createElement("h4", null, (0, lib_1.camelToTitleCase)(item.tag.substring(1))),
-        utils_1.JSX.createElement(utils_1.Raw, { html: markdown(item.content) }))))));
+    return (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" }, tags.map((item) => {
+        const name = item.name
+            ? `${(0, lib_1.camelToTitleCase)(item.tag.substring(1))}: ${item.name}`
+            : (0, lib_1.camelToTitleCase)(item.tag.substring(1));
+        return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+            utils_1.JSX.createElement("h4", null, name),
+            utils_1.JSX.createElement(utils_1.Raw, { html: markdown(item.content) })));
+    })));
 }
 exports.commentTags = commentTags;
 const flagsNotRendered = ["@showCategories", "@showGroups", "@hideCategories", "@hideGroups"];

package/dist/lib/output/themes/default/partials/member.signatures.js

@@ -6,7 +6,8 @@ const anchor_icon_1 = require("./anchor-icon");
 const lib_1 = require("../../lib");
 const memberSignatures = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
     utils_1.JSX.createElement("ul", { class: (0, lib_1.classNames)({ "tsd-signatures": true }, context.getReflectionClasses(props)) }, props.signatures?.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        utils_1.JSX.createElement("li", { class: "tsd-signature tsd-anchor-link", id: item.anchor },
+        utils_1.JSX.createElement("li", { class: "tsd-signature tsd-anchor-link" },
+            utils_1.JSX.createElement("a", { id: item.anchor, class: "tsd-anchor" }),
             context.memberSignatureTitle(item),
             (0, anchor_icon_1.anchorIcon)(context, item.anchor)),
         utils_1.JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(item))))))));

package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts

@@ -0,0 +1,4 @@
+import { type Reflection } from "../../../../models";
+import { JSX } from "../../../../utils";
+import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
+export declare function reflectionPreview(context: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;

package/dist/lib/output/themes/default/partials/reflectionPreview.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reflectionPreview = void 0;
+const models_1 = require("../../../../models");
+const utils_1 = require("../../../../utils");
+const lib_1 = require("../../lib");
+function reflectionPreview(context, props) {
+    if (!(props instanceof models_1.DeclarationReflection))
+        return;
+    // Each property of the interface will have a member rendered later on the page describing it, so generate
+    // a type-like object with links to each member.
+    if (props.kindOf(models_1.ReflectionKind.Interface)) {
+        return (utils_1.JSX.createElement("div", { class: "tsd-signature" },
+            utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "interface "),
+            utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(props) },
+                props.name,
+                " "),
+            context.type(new models_1.ReflectionType(props), { topLevelLinks: true })));
+    }
+}
+exports.reflectionPreview = reflectionPreview;

package/dist/lib/output/themes/default/partials/type.d.ts

@@ -2,4 +2,6 @@ import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { Type } from "../../../../models";
 import { JSX } from "../../../../utils";
 export declare function validateStateIsClean(page: string): void;
-export declare function type(context: DefaultThemeRenderContext, type: Type | undefined): JSX.Element;
+export declare function type(context: DefaultThemeRenderContext, type: Type | undefined, options?: {
+    topLevelLinks: boolean;
+}): JSX.Element;

package/dist/lib/output/themes/default/partials/type.js

@@ -74,7 +74,7 @@ const typeRenderers = {
         indentationDepth++;
         const parts = [
             renderType(context, type.checkType, models_1.TypeContext.conditionalCheck),
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " extends "),
+            utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, " extends "),
             renderType(context, type.extendsType, models_1.TypeContext.conditionalExtends),
             utils_1.JSX.createElement("br", null),
             includeIndentation(),
@@ -107,11 +107,11 @@ const typeRenderers = {
     },
     inferred(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "infer "),
+            utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "infer "),
             " ",
             utils_1.JSX.createElement("span", { class: "tsd-kind-type-parameter" }, type.name),
             type.constraint && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " extends "),
+                utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, " extends "),
                 renderType(context, type.constraint, models_1.TypeContext.inferredConstraint)))));
     },
     intersection(context, type) {
@@ -128,15 +128,17 @@ const typeRenderers = {
         const parts = [utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "{"), utils_1.JSX.createElement("br", null), includeIndentation()];
         switch (type.readonlyModifier) {
             case "+":
-                parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "readonly "));
+                parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "readonly "));
                 break;
             case "-":
-                parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "-readonly "));
+                parts.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+                    utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "-"),
+                    utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "readonly ")));
                 break;
         }
-        parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "["), utils_1.JSX.createElement("span", { class: "tsd-kind-type-parameter" }, type.parameter), utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " in "), renderType(context, type.parameterType, models_1.TypeContext.mappedParameter));
+        parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "["), utils_1.JSX.createElement("span", { class: "tsd-kind-type-parameter" }, type.parameter), utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, " in "), renderType(context, type.parameterType, models_1.TypeContext.mappedParameter));
         if (type.nameType) {
-            parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " as "), renderType(context, type.nameType, models_1.TypeContext.mappedName));
+            parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, " as "), renderType(context, type.nameType, models_1.TypeContext.mappedName));
         }
         parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "]"));
         switch (type.optionalModifier) {
@@ -170,15 +172,15 @@ const typeRenderers = {
     },
     predicate(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            !!type.asserts && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "asserts "),
+            !!type.asserts && utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "asserts "),
             utils_1.JSX.createElement("span", { class: "tsd-kind-parameter" }, type.name),
             !!type.targetType && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " is "),
+                utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, " is "),
                 renderType(context, type.targetType, models_1.TypeContext.predicateTarget)))));
     },
     query(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "typeof "),
+            utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "typeof "),
             renderType(context, type.queryType, models_1.TypeContext.queryTypeTarget)));
     },
     reference(context, type) {
@@ -211,30 +213,31 @@ const typeRenderers = {
         }
         return name;
     },
-    reflection(context, type) {
+    reflection(context, type, { topLevelLinks }) {
         const members = [];
         const children = type.declaration.children || [];
         indentationDepth++;
+        const renderName = (named) => topLevelLinks ? (utils_1.JSX.createElement("a", { class: (0, lib_1.getKindClass)(named), href: context.urlTo(named) }, named.name)) : (utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(named) }, named.name));
         for (const item of children) {
             if (item.getSignature && item.setSignature) {
                 members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                    utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item) }, item.name),
+                    renderName(item),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ": "),
                     renderType(context, item.getSignature.type, models_1.TypeContext.none)));
                 continue;
             }
             if (item.getSignature) {
                 members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                    utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "get "),
-                    utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item.getSignature) }, item.name),
+                    utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "get "),
+                    renderName(item.getSignature),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "(): "),
                     renderType(context, item.getSignature.type, models_1.TypeContext.none)));
                 continue;
             }
             if (item.setSignature) {
                 members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                    utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "set "),
-                    utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item.setSignature) }, item.name),
+                    utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "set "),
+                    renderName(item.setSignature),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "("),
                     item.setSignature.parameters?.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                         item.name,
@@ -246,17 +249,17 @@ const typeRenderers = {
             if (item.signatures) {
                 for (const sig of item.signatures) {
                     members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                        utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(sig) }, item.name),
+                        renderName(sig),
                         item.flags.isOptional && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "?"),
                         context.memberSignatureTitle(sig, {
                             hideName: true,
-                            arrowStyle: true,
+                            arrowStyle: false,
                         })));
                 }
                 continue;
             }
             members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item) }, item.name),
+                renderName(item),
                 utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, item.flags.isOptional ? "?: " : ": "),
                 renderType(context, item.type, models_1.TypeContext.none)));
         }
@@ -331,7 +334,7 @@ const typeRenderers = {
     },
     typeOperator(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
+            utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" },
                 type.operator,
                 " "),
             renderType(context, type.target, models_1.TypeContext.typeOperatorTarget)));
@@ -343,12 +346,12 @@ const typeRenderers = {
         return utils_1.JSX.createElement(utils_1.JSX.Fragment, null, type.name);
     },
 };
-function renderType(context, type, where) {
+function renderType(context, type, where, options = { topLevelLinks: false }) {
     if (!type) {
         return utils_1.JSX.createElement("span", { class: "tsd-signature-type" }, "any");
     }
     const renderFn = typeRenderers[type.type];
-    const rendered = renderFn(context, type);
+    const rendered = renderFn(context, type, options);
     if (type.needsParenthesis(where)) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "("),
@@ -357,7 +360,7 @@ function renderType(context, type, where) {
     }
     return rendered;
 }
-function type(context, type) {
-    return renderType(context, type, models_1.TypeContext.none);
+function type(context, type, options = { topLevelLinks: false }) {
+    return renderType(context, type, models_1.TypeContext.none, options);
 }
 exports.type = type;

package/dist/lib/output/themes/default/templates/reflection.js

@@ -5,7 +5,7 @@ const lib_1 = require("../../lib");
 const models_1 = require("../../../../models");
 const utils_1 = require("../../../../utils");
 function reflectionTemplate(context, props) {
-    if ([models_1.ReflectionKind.TypeAlias, models_1.ReflectionKind.Variable].includes(props.model.kind) &&
+    if (props.model.kindOf(models_1.ReflectionKind.TypeAlias | models_1.ReflectionKind.Variable) &&
         props.model instanceof models_1.DeclarationReflection) {
         return context.memberDeclaration(props.model);
     }
@@ -17,6 +17,7 @@ function reflectionTemplate(context, props) {
             props.model.kind === models_1.ReflectionKind.Module &&
             props.model.readme?.length && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-typography" },
             utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown(props.model.readme) }))),
+        context.reflectionPreview(props.model),
         (0, lib_1.hasTypeParameters)(props.model) && utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             " ",
             context.typeParameters(props.model.typeParameters),

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

@@ -4,8 +4,8 @@ exports.getDefaultValue = exports.convert = exports.ParameterType = exports.Para
 const path_1 = require("path");
 /** @enum */
 exports.EmitStrategy = {
-    both: "both",
-    docs: "docs",
+    both: "both", // Emit both documentation and JS
+    docs: "docs", // Emit documentation, but not JS (default)
     none: "none", // Emit nothing, just convert and run validation
 };
 /**

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

@@ -46,6 +46,7 @@ class Options {
         options.packageDir = packageDir;
         options._readers = this._readers.filter((reader) => reader.supportsPackages);
         options._declarations = new Map(this._declarations);
+        options.reset();
         return options;
     }
     /**
@@ -85,7 +86,7 @@ class Options {
         if (name != null) {
             const declaration = this.getDeclaration(name);
             if (!declaration) {
-                throw new Error("Cannot reset an option which has not been declared.");
+                throw new Error(`Cannot reset an option (${name}) which has not been declared.`);
             }
             this._values[declaration.name] = (0, declaration_2.getDefaultValue)(declaration);
             this._setOptions.delete(declaration.name);
@@ -137,7 +138,7 @@ class Options {
     }
     isSet(name) {
         if (!this._declarations.has(name)) {
-            throw new Error("Tried to check if an undefined option was set");
+            throw new Error(`Tried to check if an undefined option (${name}) was set`);
         }
         return this._setOptions.has(name);
     }
@@ -157,7 +158,7 @@ class Options {
     }
     setValue(name, value, configPath) {
         if (this.isFrozen()) {
-            throw new Error("Tried to modify an option value after options have been frozen.");
+            throw new Error(`Tried to modify an option (${name}) value after options have been frozen.`);
         }
         const declaration = this.getDeclaration(name);
         if (!declaration) {
@@ -212,7 +213,7 @@ class Options {
      */
     setCompilerOptions(fileNames, options, projectReferences) {
         if (this.isFrozen()) {
-            throw new Error("Tried to modify an option value after options have been sealed.");
+            throw new Error("Tried to modify compiler options after options have been frozen.");
         }
         // We do this here instead of in the tsconfig reader so that API consumers which
         // supply a program to `Converter.convert` instead of letting TypeDoc create one
@@ -264,7 +265,7 @@ function Option(name) {
                 return value;
             },
             set(_value) {
-                throw new Error("Options may not be set via the Option decorator");
+                throw new Error(`Options may not be set via the Option decorator when setting ${name}`);
             },
         };
     };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.25.3",
+  "version": "0.25.4",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -30,7 +30,7 @@
     "shiki": "^0.14.1"
   },
   "peerDependencies": {
-    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x"
+    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x"
   },
   "devDependencies": {
     "@types/lunr": "^2.3.5",
@@ -47,7 +47,7 @@
     "prettier": "3.0.3",
     "puppeteer": "^13.5.2",
     "ts-node": "^10.9.1",
-    "typescript": "5.2.2"
+    "typescript": "5.3.2"
   },
   "files": [
     "/bin",
@@ -64,7 +64,9 @@
     "test": "mocha --config .config/mocha.fast.json",
     "test:cov": "c8 mocha --config .config/mocha.fast.json",
     "doc:c": "node bin/typedoc --tsconfig src/test/converter/tsconfig.json",
-    "doc:c2": "node --inspect-brk bin/typedoc --tsconfig src/test/converter2/tsconfig.json",
+    "doc:c2": "node bin/typedoc --tsconfig src/test/converter2/tsconfig.json",
+    "doc:c2d": "node --inspect-brk bin/typedoc --tsconfig src/test/converter2/tsconfig.json",
+    "example": "cd example && node ../bin/typedoc",
     "test:full": "c8 mocha --config .config/mocha.full.json",
     "test:visual": "ts-node ./src/test/capture-screenshots.ts && ./scripts/compare_screenshots.sh",
     "test:visual:accept": "node scripts/accept_visual_regression.js",

package/static/style.css

@@ -11,6 +11,7 @@
     --light-color-text-aside: #6e6e6e;
     --light-color-link: #1f70c2;
 
+    --light-color-ts-keyword: #056bd6;
     --light-color-ts-project: #b111c9;
     --light-color-ts-module: var(--light-color-ts-project);
     --light-color-ts-namespace: var(--light-color-ts-project);
@@ -50,6 +51,7 @@
     --dark-color-text-aside: #dddddd;
     --dark-color-link: #00aff4;
 
+    --dark-color-ts-keyword: #3399ff;
     --dark-color-ts-project: #e358ff;
     --dark-color-ts-module: var(--dark-color-ts-project);
     --dark-color-ts-namespace: var(--dark-color-ts-project);
@@ -91,6 +93,7 @@
         --color-text-aside: var(--light-color-text-aside);
         --color-link: var(--light-color-link);
 
+        --color-ts-keyword: var(--light-color-ts-keyword);
         --color-ts-module: var(--light-color-ts-module);
         --color-ts-namespace: var(--light-color-ts-namespace);
         --color-ts-enum: var(--light-color-ts-enum);
@@ -132,6 +135,7 @@
         --color-text-aside: var(--dark-color-text-aside);
         --color-link: var(--dark-color-link);
 
+        --color-ts-keyword: var(--dark-color-ts-keyword);
         --color-ts-module: var(--dark-color-ts-module);
         --color-ts-namespace: var(--dark-color-ts-namespace);
         --color-ts-enum: var(--dark-color-ts-enum);
@@ -180,6 +184,7 @@ body {
     --color-text-aside: var(--light-color-text-aside);
     --color-link: var(--light-color-link);
 
+    --color-ts-keyword: var(--light-color-ts-keyword);
     --color-ts-module: var(--light-color-ts-module);
     --color-ts-namespace: var(--light-color-ts-namespace);
     --color-ts-enum: var(--light-color-ts-enum);
@@ -219,6 +224,7 @@ body {
     --color-text-aside: var(--dark-color-text-aside);
     --color-link: var(--dark-color-link);
 
+    --color-ts-keyword: var(--dark-color-ts-keyword);
     --color-ts-module: var(--dark-color-ts-module);
     --color-ts-namespace: var(--dark-color-ts-namespace);
     --color-ts-enum: var(--dark-color-ts-enum);
@@ -984,6 +990,11 @@ a.tsd-index-link {
     overflow-x: auto;
 }
 
+.tsd-signature-keyword {
+    color: var(--color-ts-keyword);
+    font-weight: normal;
+}
+
 .tsd-signature-symbol {
     color: var(--color-text-aside);
     font-weight: normal;