typedoc 0.25.8 → 0.25.9

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

@@ -38,6 +38,8 @@ export declare class Converter extends ChildableComponent<Application, Converter
     accessor useTsLinkResolution: boolean;
     /** @internal */
     accessor preserveLinkText: boolean;
+    /** @internal */
+    accessor maxTypeConversionDepth: number;
     private _config?;
     private _externalSymbolResolvers;
     get config(): CommentParserConfig;

package/dist/lib/converter/converter.js

@@ -71,7 +71,7 @@ const linkResolver_1 = require("./comments/linkResolver");
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  */
 let Converter = (() => {
-    var _Converter_externalPattern_accessor_storage, _Converter_excludeExternals_accessor_storage, _Converter_excludeNotDocumented_accessor_storage, _Converter_excludePrivate_accessor_storage, _Converter_excludeProtected_accessor_storage, _Converter_excludeReferences_accessor_storage, _Converter_commentStyle_accessor_storage, _Converter_validation_accessor_storage, _Converter_externalSymbolLinkMappings_accessor_storage, _Converter_useTsLinkResolution_accessor_storage, _Converter_preserveLinkText_accessor_storage;
+    var _Converter_externalPattern_accessor_storage, _Converter_excludeExternals_accessor_storage, _Converter_excludeNotDocumented_accessor_storage, _Converter_excludePrivate_accessor_storage, _Converter_excludeProtected_accessor_storage, _Converter_excludeReferences_accessor_storage, _Converter_commentStyle_accessor_storage, _Converter_validation_accessor_storage, _Converter_externalSymbolLinkMappings_accessor_storage, _Converter_useTsLinkResolution_accessor_storage, _Converter_preserveLinkText_accessor_storage, _Converter_maxTypeConversionDepth_accessor_storage;
     let _classDecorators = [(0, component_1.Component)({
             name: "converter",
             internal: true,
@@ -104,6 +104,8 @@ let Converter = (() => {
     let _useTsLinkResolution_initializers = [];
     let _preserveLinkText_decorators;
     let _preserveLinkText_initializers = [];
+    let _maxTypeConversionDepth_decorators;
+    let _maxTypeConversionDepth_initializers = [];
     var Converter = _classThis = class extends _classSuper {
         /** @internal */
         get externalPattern() { return __classPrivateFieldGet(this, _Converter_externalPattern_accessor_storage, "f"); }
@@ -138,6 +140,9 @@ let Converter = (() => {
         /** @internal */
         get preserveLinkText() { return __classPrivateFieldGet(this, _Converter_preserveLinkText_accessor_storage, "f"); }
         set preserveLinkText(value) { __classPrivateFieldSet(this, _Converter_preserveLinkText_accessor_storage, value, "f"); }
+        /** @internal */
+        get maxTypeConversionDepth() { return __classPrivateFieldGet(this, _Converter_maxTypeConversionDepth_accessor_storage, "f"); }
+        set maxTypeConversionDepth(value) { __classPrivateFieldSet(this, _Converter_maxTypeConversionDepth_accessor_storage, value, "f"); }
         get config() {
             return this._config || this._buildCommentParserConfig();
         }
@@ -154,6 +159,7 @@ let Converter = (() => {
             _Converter_externalSymbolLinkMappings_accessor_storage.set(this, __runInitializers(this, _externalSymbolLinkMappings_initializers, void 0));
             _Converter_useTsLinkResolution_accessor_storage.set(this, __runInitializers(this, _useTsLinkResolution_initializers, void 0));
             _Converter_preserveLinkText_accessor_storage.set(this, __runInitializers(this, _preserveLinkText_initializers, void 0));
+            _Converter_maxTypeConversionDepth_accessor_storage.set(this, __runInitializers(this, _maxTypeConversionDepth_initializers, void 0));
             this._externalSymbolResolvers = [];
             this.addUnknownSymbolResolver((ref) => {
                 // Require global links, matching local ones will likely hide mistakes where the
@@ -378,6 +384,7 @@ let Converter = (() => {
     _Converter_externalSymbolLinkMappings_accessor_storage = new WeakMap();
     _Converter_useTsLinkResolution_accessor_storage = new WeakMap();
     _Converter_preserveLinkText_accessor_storage = new WeakMap();
+    _Converter_maxTypeConversionDepth_accessor_storage = new WeakMap();
     __setFunctionName(_classThis, "Converter");
     (() => {
         const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
@@ -392,6 +399,7 @@ let Converter = (() => {
         _externalSymbolLinkMappings_decorators = [(0, utils_1.Option)("externalSymbolLinkMappings")];
         _useTsLinkResolution_decorators = [(0, utils_1.Option)("useTsLinkResolution")];
         _preserveLinkText_decorators = [(0, utils_1.Option)("preserveLinkText")];
+        _maxTypeConversionDepth_decorators = [(0, utils_1.Option)("maxTypeConversionDepth")];
         __esDecorate(_classThis, null, _externalPattern_decorators, { kind: "accessor", name: "externalPattern", static: false, private: false, access: { has: obj => "externalPattern" in obj, get: obj => obj.externalPattern, set: (obj, value) => { obj.externalPattern = value; } }, metadata: _metadata }, _externalPattern_initializers, _instanceExtraInitializers);
         __esDecorate(_classThis, null, _excludeExternals_decorators, { kind: "accessor", name: "excludeExternals", static: false, private: false, access: { has: obj => "excludeExternals" in obj, get: obj => obj.excludeExternals, set: (obj, value) => { obj.excludeExternals = value; } }, metadata: _metadata }, _excludeExternals_initializers, _instanceExtraInitializers);
         __esDecorate(_classThis, null, _excludeNotDocumented_decorators, { kind: "accessor", name: "excludeNotDocumented", static: false, private: false, access: { has: obj => "excludeNotDocumented" in obj, get: obj => obj.excludeNotDocumented, set: (obj, value) => { obj.excludeNotDocumented = value; } }, metadata: _metadata }, _excludeNotDocumented_initializers, _instanceExtraInitializers);
@@ -403,6 +411,7 @@ let Converter = (() => {
         __esDecorate(_classThis, null, _externalSymbolLinkMappings_decorators, { kind: "accessor", name: "externalSymbolLinkMappings", static: false, private: false, access: { has: obj => "externalSymbolLinkMappings" in obj, get: obj => obj.externalSymbolLinkMappings, set: (obj, value) => { obj.externalSymbolLinkMappings = value; } }, metadata: _metadata }, _externalSymbolLinkMappings_initializers, _instanceExtraInitializers);
         __esDecorate(_classThis, null, _useTsLinkResolution_decorators, { kind: "accessor", name: "useTsLinkResolution", static: false, private: false, access: { has: obj => "useTsLinkResolution" in obj, get: obj => obj.useTsLinkResolution, set: (obj, value) => { obj.useTsLinkResolution = value; } }, metadata: _metadata }, _useTsLinkResolution_initializers, _instanceExtraInitializers);
         __esDecorate(_classThis, null, _preserveLinkText_decorators, { kind: "accessor", name: "preserveLinkText", static: false, private: false, access: { has: obj => "preserveLinkText" in obj, get: obj => obj.preserveLinkText, set: (obj, value) => { obj.preserveLinkText = value; } }, metadata: _metadata }, _preserveLinkText_initializers, _instanceExtraInitializers);
+        __esDecorate(_classThis, null, _maxTypeConversionDepth_decorators, { kind: "accessor", name: "maxTypeConversionDepth", static: false, private: false, access: { has: obj => "maxTypeConversionDepth" in obj, get: obj => obj.maxTypeConversionDepth, set: (obj, value) => { obj.maxTypeConversionDepth = value; } }, metadata: _metadata }, _maxTypeConversionDepth_initializers, _instanceExtraInitializers);
         __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
         Converter = _classThis = _classDescriptor.value;
         if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });

package/dist/lib/converter/types.js

@@ -71,15 +71,22 @@ function maybeConvertType(context, typeOrNode) {
     }
     return convertType(context, typeOrNode);
 }
+let typeConversionDepth = 0;
 function convertType(context, typeOrNode) {
     if (!typeOrNode) {
         return new models_1.IntrinsicType("any");
     }
+    if (typeConversionDepth > context.converter.maxTypeConversionDepth) {
+        return new models_1.UnknownType("...");
+    }
     loadConverters();
     if ("kind" in typeOrNode) {
         const converter = converters.get(typeOrNode.kind);
         if (converter) {
-            return converter.convert(context, typeOrNode);
+            ++typeConversionDepth;
+            const result = converter.convert(context, typeOrNode);
+            --typeConversionDepth;
+            return result;
         }
         return requestBugReport(context, typeOrNode);
     }
@@ -88,6 +95,7 @@ function convertType(context, typeOrNode) {
     // will use the origin when serializing
     // aliasSymbol check is important - #2468
     if (typeOrNode.isUnion() && typeOrNode.origin && !typeOrNode.aliasSymbol) {
+        // Don't increment typeConversionDepth as this is a transparent step to the user.
         return convertType(context, typeOrNode.origin);
     }
     // IgnoreErrors is important, without it, we can't assert that we will get a node.
@@ -106,7 +114,9 @@ function convertType(context, typeOrNode) {
             converter = typeLiteralConverter;
         }
         seenTypes.add(typeOrNode.id);
+        ++typeConversionDepth;
         const result = converter.convertType(context, typeOrNode, node);
+        --typeConversionDepth;
         seenTypes.delete(typeOrNode.id);
         return result;
     }
@@ -643,7 +653,9 @@ const unionConverter = {
         return new models_1.UnionType(node.types.map((type) => convertType(context, type)));
     },
     convertType(context, type) {
-        return new models_1.UnionType(type.types.map((type) => convertType(context, type)));
+        const types = type.types.map((type) => convertType(context, type));
+        sortLiteralUnion(types);
+        return new models_1.UnionType(types);
     },
 };
 const jsDocNullableTypeConverter = {
@@ -695,3 +707,13 @@ function kindToModifier(kind) {
             return undefined;
     }
 }
+function sortLiteralUnion(types) {
+    if (types.some((t) => t.type !== "literal" || typeof t.value !== "number")) {
+        return;
+    }
+    types.sort((a, b) => {
+        const aLit = a;
+        const bLit = b;
+        return aLit.value - bLit.value;
+    });
+}

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

@@ -127,7 +127,7 @@ export declare abstract class Reflection {
      * The reflection this reflection is a child of.
      */
     parent?: Reflection;
-    get project(): ProjectReflection;
+    project: ProjectReflection;
     /**
      * The parsed documentation comment attached to this reflection.
      */

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

@@ -35,7 +35,6 @@ var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn,
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Reflection = exports.TraverseProperty = exports.ReflectionFlags = exports.ReflectionFlag = exports.resetReflectionID = void 0;
-const assert_1 = require("assert");
 const comment_1 = require("../comments/comment");
 const utils_1 = require("./utils");
 const kind_1 = require("./kind");
@@ -247,13 +246,9 @@ let Reflection = (() => {
     let _instanceExtraInitializers = [];
     let _parent_decorators;
     let _parent_initializers = [];
+    let _project_decorators;
+    let _project_initializers = [];
     return _a = class Reflection {
-            get project() {
-                if (this.isProject())
-                    return this;
-                (0, assert_1.ok)(this.parent, "Tried to get the project on a reflection not in a project");
-                return this.parent.project;
-            }
             constructor(name, kind, parent) {
                 /**
                  * Unique id of this reflection.
@@ -264,8 +259,10 @@ let Reflection = (() => {
                  * The reflection this reflection is a child of.
                  */
                 this.parent = __runInitializers(this, _parent_initializers, void 0);
+                this.project = __runInitializers(this, _project_initializers, void 0);
                 this.id = REFLECTION_ID++;
                 this.parent = parent;
+                this.project = parent?.project || this;
                 this.name = name;
                 this.kind = kind;
                 // If our parent is external, we are too.
@@ -471,7 +468,9 @@ let Reflection = (() => {
             const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
             _parent_decorators = [general_1.NonEnumerable // So that it doesn't show up in console.log
             ];
+            _project_decorators = [general_1.NonEnumerable];
             __esDecorate(null, null, _parent_decorators, { kind: "field", name: "parent", static: false, private: false, access: { has: obj => "parent" in obj, get: obj => obj.parent, set: (obj, value) => { obj.parent = value; } }, metadata: _metadata }, _parent_initializers, _instanceExtraInitializers);
+            __esDecorate(null, null, _project_decorators, { kind: "field", name: "project", static: false, private: false, access: { has: obj => "project" in obj, get: obj => obj.project, set: (obj, value) => { obj.project = value; } }, metadata: _metadata }, _project_initializers, _instanceExtraInitializers);
             if (_metadata) Object.defineProperty(_a, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         })(),
         _a;

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

@@ -129,18 +129,19 @@ class DeclarationReflection extends container_1.ContainerReflection {
             extendedBy: serializer.toObjectsOptional(this.extendedBy),
             implementedTypes: serializer.toObjectsOptional(this.implementedTypes),
             implementedBy: serializer.toObjectsOptional(this.implementedBy),
+            readme: comments_1.Comment.serializeDisplayParts(serializer, this.readme),
         };
     }
     fromObject(de, obj) {
         super.fromObject(de, obj);
+        if (obj.readme) {
+            this.readme = comments_1.Comment.deserializeDisplayParts(de, obj.readme);
+        }
         // This happens when merging multiple projects together.
         // If updating this, also check ProjectReflection.fromObject.
         if (obj.variant === "project") {
             this.kind = kind_1.ReflectionKind.Module;
             this.packageVersion = obj.packageVersion;
-            if (obj.readme) {
-                this.readme = comments_1.Comment.deserializeDisplayParts(de, obj.readme);
-            }
             de.defer(() => {
                 for (const [id, sid] of Object.entries(obj.symbolIdMap || {})) {
                     const refl = this.project.getReflectionById(de.oldIdToNewId[+id] ?? -1);

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

@@ -172,17 +172,17 @@ class ProjectReflection extends container_1.ContainerReflection {
         }
         this.reflectionChildren.delete(reflection.id);
         // Remove references from the TS symbol to this reflection.
-        const symbol = this.reflectionIdToSymbolMap.get(reflection.id);
-        if (symbol) {
-            const id = new ReflectionSymbolId_1.ReflectionSymbolId(symbol);
-            const saved = this.symbolToReflectionIdMap.get(id);
+        const symbolId = this.reflectionIdToSymbolIdMap.get(reflection.id);
+        if (symbolId) {
+            const saved = this.symbolToReflectionIdMap.get(symbolId);
             if (saved === reflection.id) {
-                this.symbolToReflectionIdMap.delete(id);
+                this.symbolToReflectionIdMap.delete(symbolId);
             }
             else if (typeof saved === "object") {
                 (0, utils_1.removeIfPresent)(saved, reflection.id);
             }
         }
+        this.reflectionIdToSymbolMap.delete(reflection.id);
         this.reflectionIdToSymbolIdMap.delete(reflection.id);
         delete this.reflections[reflection.id];
     }

package/dist/lib/output/themes/default/partials/member.signature.body.js

@@ -13,7 +13,7 @@ function memberSignatureBody(context, props, { hideSources = false } = {}) {
         props.parameters && props.parameters.length > 0 && (utils_1.JSX.createElement("div", { class: "tsd-parameters" },
             utils_1.JSX.createElement("h4", { class: "tsd-parameters-title" }, "Parameters"),
             utils_1.JSX.createElement("ul", { class: "tsd-parameter-list" }, props.parameters.map((item) => (utils_1.JSX.createElement("li", null,
-                utils_1.JSX.createElement("h5", null,
+                utils_1.JSX.createElement("span", null,
                     context.reflectionFlags(item),
                     !!item.flags.isRest && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
                     utils_1.JSX.createElement("span", { class: "tsd-kind-parameter" }, item.name),

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

@@ -7,7 +7,7 @@ function typeParameters(context, typeParameters) {
         utils_1.JSX.createElement("section", { class: "tsd-panel" },
             utils_1.JSX.createElement("h4", null, "Type Parameters"),
             utils_1.JSX.createElement("ul", { class: "tsd-type-parameter-list" }, typeParameters?.map((item) => (utils_1.JSX.createElement("li", null,
-                utils_1.JSX.createElement("h4", null,
+                utils_1.JSX.createElement("span", null,
                     utils_1.JSX.createElement("a", { id: item.anchor, class: "tsd-anchor" }),
                     item.flags.isConst && utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "const "),
                     item.varianceModifier && (utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" },

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

@@ -78,7 +78,7 @@ export interface ParameterReflection extends Omit<Reflection, "variant">, S<M.Pa
     variant: "param";
 }
 /** @category Reflections */
-export interface DeclarationReflection extends Omit<ContainerReflection, "variant">, S<M.DeclarationReflection, "variant" | "packageVersion" | "sources" | "relevanceBoost" | "type" | "signatures" | "indexSignature" | "defaultValue" | "overwrites" | "inheritedFrom" | "implementationOf" | "extendedTypes" | "extendedBy" | "implementedTypes" | "implementedBy" | "getSignature" | "setSignature" | "typeParameters"> {
+export interface DeclarationReflection extends Omit<ContainerReflection, "variant">, S<M.DeclarationReflection, "variant" | "packageVersion" | "sources" | "relevanceBoost" | "type" | "signatures" | "indexSignature" | "defaultValue" | "overwrites" | "inheritedFrom" | "implementationOf" | "extendedTypes" | "extendedBy" | "implementedTypes" | "implementedBy" | "getSignature" | "setSignature" | "typeParameters" | "readme"> {
 }
 /** @category Reflections */
 export interface TypeParameterReflection extends Omit<Reflection, "variant">, S<M.TypeParameterReflection, "variant" | "type" | "default" | "varianceModifier"> {

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

@@ -72,6 +72,7 @@ export interface TypeDocOptionMap {
     excludeProtected: boolean;
     excludeReferences: boolean;
     excludeCategories: string[];
+    maxTypeConversionDepth: number;
     name: string;
     includeVersion: boolean;
     disableSources: boolean;

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

@@ -278,6 +278,12 @@ function addTypeDocOptions(options) {
             }
         },
     });
+    options.addDeclaration({
+        name: "maxTypeConversionDepth",
+        help: "Set the maximum depth of types to be converted.",
+        defaultValue: 10,
+        type: declaration_1.ParameterType.Number,
+    });
     options.addDeclaration({
         name: "name",
         help: "Set the name of the project that will be used in the header of the template.",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.25.8",
+  "version": "0.25.9",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",