typedoc 0.23.14 → 0.23.15

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

@@ -104,7 +104,7 @@ export declare class Converter extends ChildableComponent<Application, Converter
      */
     convert(entryPoints: readonly DocumentationEntryPoint[]): ProjectReflection;
     /** @internal */
-    convertSymbol(context: Context, symbol: ts.Symbol): void;
+    convertSymbol(context: Context, symbol: ts.Symbol, exportSymbol?: ts.Symbol): void;
     /**
      * Convert the given TypeScript type into its TypeDoc type reflection.
      *

package/dist/lib/converter/converter.js

@@ -72,8 +72,8 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         return project;
     }
     /** @internal */
-    convertSymbol(context, symbol) {
-        (0, symbols_1.convertSymbol)(context, symbol);
+    convertSymbol(context, symbol, exportSymbol) {
+        (0, symbols_1.convertSymbol)(context, symbol, exportSymbol);
     }
     /**
      * Convert the given TypeScript type into its TypeDoc type reflection.

package/dist/lib/converter/factories/signature.js

@@ -15,7 +15,12 @@ function createSignature(context, kind, signature, declaration) {
     const sigRef = new models_1.SignatureReflection(kind == models_1.ReflectionKind.ConstructorSignature
         ? `new ${context.scope.parent.name}`
         : context.scope.name, kind, context.scope);
-    if (declaration) {
+    // If we are creating signatures for a variable and the variable has a comment associated with it
+    // then we should prefer that variable's comment over any comment on the signature. The comment plugin
+    // will copy the comment down if this signature doesn't have one, so don't set one.
+    if (declaration &&
+        (!context.scope.comment ||
+            !(context.scope.conversionFlags & models_1.ConversionFlags.VariableSource))) {
         sigRef.comment = (0, comments_1.getSignatureComment)(declaration, context.converter.config, context.logger, context.converter.commentStyle);
     }
     sigRef.typeParameters = convertTypeParameters(context, sigRef, signature.typeParameters);

package/dist/lib/converter/jsdoc.js

@@ -16,6 +16,14 @@ function convertJsDocAlias(context, symbol, declaration, exportSymbol) {
         convertJsDocInterface(context, declaration, symbol, exportSymbol);
         return;
     }
+    // If the typedef tag is just referring to another type-space symbol, with no type parameters
+    // or appropriate forwarding type parameters, then we treat it as a re-export instead of creating
+    // a type alias with an import type.
+    const aliasedSymbol = getTypedefReExportTarget(context, declaration);
+    if (aliasedSymbol) {
+        context.converter.convertSymbol(context, aliasedSymbol, exportSymbol ?? symbol);
+        return;
+    }
     const reflection = context.createDeclarationReflection(models_1.ReflectionKind.TypeAlias, symbol, exportSymbol);
     reflection.comment = (0, comments_1.getJsDocComment)(declaration, context.converter.config, context.logger);
     reflection.type = context.converter.convertType(context.withScope(reflection), declaration.typeExpression?.type);
@@ -69,3 +77,36 @@ function convertTemplateParameterNodes(context, nodes) {
     const params = (nodes ?? []).flatMap((tag) => tag.typeParameters);
     return (0, signature_1.convertTypeParameterNodes)(context, params);
 }
+function getTypedefReExportTarget(context, declaration) {
+    const typeExpression = declaration.typeExpression;
+    if (!ts.isJSDocTypedefTag(declaration) ||
+        !typeExpression ||
+        ts.isJSDocTypeLiteral(typeExpression) ||
+        !ts.isImportTypeNode(typeExpression.type) ||
+        !typeExpression.type.qualifier ||
+        !ts.isIdentifier(typeExpression.type.qualifier)) {
+        return;
+    }
+    const targetSymbol = context.expectSymbolAtLocation(typeExpression.type.qualifier);
+    const decl = targetSymbol.declarations?.[0];
+    if (!decl ||
+        !(ts.isTypeAliasDeclaration(decl) ||
+            ts.isInterfaceDeclaration(decl) ||
+            ts.isJSDocTypedefTag(decl) ||
+            ts.isJSDocCallbackTag(decl))) {
+        return;
+    }
+    const targetParams = ts.getEffectiveTypeParameterDeclarations(decl);
+    const localParams = ts.getEffectiveTypeParameterDeclarations(declaration);
+    const localArgs = typeExpression.type.typeArguments || [];
+    // If we have type parameters, ensure they are forwarding parameters with no transformations.
+    // This doesn't check constraints since they aren't checked in JSDoc types.
+    if (targetParams.length !== localParams.length ||
+        localArgs.some((arg, i) => !ts.isTypeReferenceNode(arg) ||
+            !ts.isIdentifier(arg.typeName) ||
+            arg.typeArguments ||
+            localParams[i]?.name.text !== arg.typeName.text)) {
+        return;
+    }
+    return targetSymbol;
+}

package/dist/lib/converter/symbols.js

@@ -477,6 +477,7 @@ function convertVariableAsFunction(context, symbol, exportSymbol) {
         : context.checker.getDeclaredTypeOfSymbol(symbol);
     const reflection = context.createDeclarationReflection(models_1.ReflectionKind.Function, symbol, exportSymbol);
     setModifiers(symbol, accessDeclaration, reflection);
+    reflection.conversionFlags |= models_1.ConversionFlags.VariableSource;
     context.finalizeDeclarationReflection(reflection);
     const reflectionContext = context.withScope(reflection);
     reflection.signatures ?? (reflection.signatures = []);

package/dist/lib/converter/types.js

@@ -9,6 +9,7 @@ const converter_events_1 = require("./converter-events");
 const index_signature_1 = require("./factories/index-signature");
 const signature_1 = require("./factories/signature");
 const symbols_1 = require("./symbols");
+const nodes_1 = require("./utils/nodes");
 const reflections_1 = require("./utils/reflections");
 const converters = new Map();
 function loadConverters() {
@@ -576,7 +577,7 @@ const typeOperatorConverter = {
         // readonly is only valid on array and tuple literal types.
         if (node.operator === ts.SyntaxKind.ReadonlyKeyword) {
             const resolved = resolveReference(type);
-            assert(isObjectType(resolved));
+            assert((0, nodes_1.isObjectType)(resolved));
             const args = context.checker
                 .getTypeArguments(type)
                 .map((type) => convertType(context, type));
@@ -645,11 +646,8 @@ function requestBugReport(context, nodeOrType) {
         return new models_1.UnknownType(typeString);
     }
 }
-function isObjectType(type) {
-    return typeof type.objectFlags === "number";
-}
 function resolveReference(type) {
-    if (isObjectType(type) && type.objectFlags & ts.ObjectFlags.Reference) {
+    if ((0, nodes_1.isObjectType)(type) && type.objectFlags & ts.ObjectFlags.Reference) {
         return type.target;
     }
     return type;

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

@@ -3,3 +3,4 @@ export declare function isNamedNode(node: ts.Node): node is ts.Node & {
     name: ts.Identifier | ts.PrivateIdentifier | ts.ComputedPropertyName;
 };
 export declare function getHeritageTypes(declarations: readonly (ts.ClassDeclaration | ts.InterfaceDeclaration)[], kind: ts.SyntaxKind.ImplementsKeyword | ts.SyntaxKind.ExtendsKeyword): ts.ExpressionWithTypeArguments[];
+export declare function isObjectType(type: ts.Type): type is ts.ObjectType;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHeritageTypes = exports.isNamedNode = void 0;
+exports.isObjectType = exports.getHeritageTypes = exports.isNamedNode = void 0;
 const ts = require("typescript");
 function isNamedNode(node) {
     const name = node.name;
@@ -22,3 +22,7 @@ function getHeritageTypes(declarations, kind) {
     });
 }
 exports.getHeritageTypes = getHeritageTypes;
+function isObjectType(type) {
+    return typeof type.objectFlags === "number";
+}
+exports.isObjectType = isObjectType;

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

@@ -25,6 +25,13 @@ export interface DeclarationHierarchy {
      */
     isTarget?: boolean;
 }
+/**
+ * @internal
+ */
+export declare enum ConversionFlags {
+    None = 0,
+    VariableSource = 1
+}
 /**
  * A reflection that represents a single declaration emitted by the TypeScript compiler.
  *
@@ -118,6 +125,11 @@ export declare class DeclarationReflection extends ContainerReflection {
      * The version of the module when found.
      */
     version?: string;
+    /**
+     * Flags for information about a reflection which is needed solely during conversion.
+     * @internal
+     */
+    conversionFlags: ConversionFlags;
     hasGetterOrSetter(): boolean;
     getAllSignatures(): SignatureReflection[];
     /** @internal */

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

@@ -1,9 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeclarationReflection = void 0;
+exports.DeclarationReflection = exports.ConversionFlags = void 0;
 const types_1 = require("../types");
 const abstract_1 = require("./abstract");
 const container_1 = require("./container");
+/**
+ * @internal
+ */
+var ConversionFlags;
+(function (ConversionFlags) {
+    ConversionFlags[ConversionFlags["None"] = 0] = "None";
+    ConversionFlags[ConversionFlags["VariableSource"] = 1] = "VariableSource";
+})(ConversionFlags = exports.ConversionFlags || (exports.ConversionFlags = {}));
 /**
  * A reflection that represents a single declaration emitted by the TypeScript compiler.
  *
@@ -11,6 +19,14 @@ const container_1 = require("./container");
  * kind of a reflection is stored in its ´kind´ member.
  */
 class DeclarationReflection extends container_1.ContainerReflection {
+    constructor() {
+        super(...arguments);
+        /**
+         * Flags for information about a reflection which is needed solely during conversion.
+         * @internal
+         */
+        this.conversionFlags = ConversionFlags.None;
+    }
     hasGetterOrSetter() {
         return !!this.getSignature || !!this.setSignature;
     }

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

@@ -1,7 +1,7 @@
 export { Reflection, ReflectionFlag, ReflectionFlags, TraverseProperty, } from "./abstract";
 export type { TraverseCallback } from "./abstract";
 export { ContainerReflection } from "./container";
-export { DeclarationReflection } from "./declaration";
+export { DeclarationReflection, ConversionFlags } from "./declaration";
 export type { DeclarationHierarchy } from "./declaration";
 export { ReflectionKind } from "./kind";
 export { ParameterReflection } from "./parameter";

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.splitUnquotedString = exports.VarianceModifier = exports.TypeParameterReflection = exports.SignatureReflection = exports.ReferenceReflection = exports.ProjectReflection = exports.ParameterReflection = exports.ReflectionKind = exports.DeclarationReflection = exports.ContainerReflection = exports.TraverseProperty = exports.ReflectionFlags = exports.ReflectionFlag = exports.Reflection = void 0;
+exports.splitUnquotedString = exports.VarianceModifier = exports.TypeParameterReflection = exports.SignatureReflection = exports.ReferenceReflection = exports.ProjectReflection = exports.ParameterReflection = exports.ReflectionKind = exports.ConversionFlags = exports.DeclarationReflection = exports.ContainerReflection = exports.TraverseProperty = exports.ReflectionFlags = exports.ReflectionFlag = exports.Reflection = void 0;
 var abstract_1 = require("./abstract");
 Object.defineProperty(exports, "Reflection", { enumerable: true, get: function () { return abstract_1.Reflection; } });
 Object.defineProperty(exports, "ReflectionFlag", { enumerable: true, get: function () { return abstract_1.ReflectionFlag; } });
@@ -10,6 +10,7 @@ var container_1 = require("./container");
 Object.defineProperty(exports, "ContainerReflection", { enumerable: true, get: function () { return container_1.ContainerReflection; } });
 var declaration_1 = require("./declaration");
 Object.defineProperty(exports, "DeclarationReflection", { enumerable: true, get: function () { return declaration_1.DeclarationReflection; } });
+Object.defineProperty(exports, "ConversionFlags", { enumerable: true, get: function () { return declaration_1.ConversionFlags; } });
 var kind_1 = require("./kind");
 Object.defineProperty(exports, "ReflectionKind", { enumerable: true, get: function () { return kind_1.ReflectionKind; } });
 var parameter_1 = require("./parameter");

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

@@ -26,7 +26,7 @@ export declare class DefaultThemeRenderContext {
     comment: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
     footer: () => import("../../../utils/jsx.elements").JsxElement | undefined;
     header: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
-    hierarchy: (props: import("../../../models").DeclarationHierarchy | undefined) => import("../../../utils/jsx.elements").JsxElement;
+    hierarchy: (props: import("../../../models").DeclarationHierarchy | undefined) => import("../../../utils/jsx.elements").JsxElement | undefined;
     index: (props: import("../../../models").ContainerReflection) => import("../../../utils/jsx.elements").JsxElement;
     member: (props: import("../../../models").DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
     memberDeclaration: (props: import("../../../models").DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;

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

@@ -1,4 +1,4 @@
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { JSX } from "../../../../utils";
 import type { DeclarationHierarchy } from "../../../../models";
-export declare const hierarchy: (context: DefaultThemeRenderContext, props: DeclarationHierarchy | undefined) => JSX.Element;
+export declare function hierarchy(context: DefaultThemeRenderContext, props: DeclarationHierarchy | undefined): JSX.Element | undefined;

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

@@ -2,9 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hierarchy = void 0;
 const utils_1 = require("../../../../utils");
-const hierarchy = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, !!props && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-hierarchy" },
-    utils_1.JSX.createElement("h4", null, "Hierarchy"),
-    utils_1.JSX.createElement("ul", { class: "tsd-hierarchy" }, props.types.map((item, i, l) => (utils_1.JSX.createElement("li", null,
-        props.isTarget ? utils_1.JSX.createElement("span", { class: "target" }, item.toString()) : context.type(item),
-        i === l.length - 1 && !!props.next && context.hierarchy(props.next)))))))));
+function hierarchy(context, props) {
+    if (!props)
+        return;
+    return (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-hierarchy" },
+        utils_1.JSX.createElement("h4", null, "Hierarchy"),
+        hierarchyList(context, props)));
+}
 exports.hierarchy = hierarchy;
+function hierarchyList(context, props) {
+    return (utils_1.JSX.createElement("ul", { class: "tsd-hierarchy" }, props.types.map((item, i, l) => (utils_1.JSX.createElement("li", null,
+        props.isTarget ? utils_1.JSX.createElement("span", { class: "target" }, item.toString()) : context.type(item),
+        i === l.length - 1 && !!props.next && hierarchyList(context, props.next))))));
+}

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

@@ -19,9 +19,7 @@ const memberDeclaration = (context, props) => (utils_1.JSX.createElement(utils_1
                 " = ",
                 props.defaultValue)))),
     context.comment(props),
-    (0, lib_1.hasTypeParameters)(props) && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        utils_1.JSX.createElement("h4", { class: "tsd-type-parameters-title" }, "Type Parameters"),
-        context.typeParameters(props.typeParameters))),
+    (0, lib_1.hasTypeParameters)(props) && context.typeParameters(props.typeParameters),
     props.type instanceof models_1.ReflectionType && (utils_1.JSX.createElement("div", { class: "tsd-type-declaration" },
         utils_1.JSX.createElement("h4", null, "Type declaration"),
         context.parameter(props.type.declaration))),

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

@@ -7,9 +7,7 @@ const lib_1 = require("../../lib");
 const memberSignatureBody = (context, props, { hideSources = false } = {}) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
     (0, lib_1.renderFlags)(props.flags, props.comment),
     context.comment(props),
-    (0, lib_1.hasTypeParameters)(props) && (utils_1.JSX.createElement("div", { class: "tsd-type-parameters" },
-        utils_1.JSX.createElement("h4", { class: "tsd-type-parameters-title" }, "Type Parameters"),
-        context.typeParameters(props.typeParameters))),
+    (0, lib_1.hasTypeParameters)(props) && context.typeParameters(props.typeParameters),
     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,

package/package.json

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