typedoc 0.23.24 → 0.23.26

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { EventDispatcher, Event } from "./lib/utils/events";
 export { resetReflectionID } from "./lib/models/reflections/abstract";
 export { normalizePath } from "./lib/utils/fs";
 export * from "./lib/models";
-export { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, } from "./lib/converter";
+export { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, type ExternalResolveResult, type ExternalSymbolResolver, } from "./lib/converter";
 export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
 export type { RenderTemplate, RendererHooks } from "./lib/output";
 export { ArgumentsReader, BindOption, CommentStyle, JSX, LogLevel, Logger, Options, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, } from "./lib/utils";
@@ -11,5 +11,5 @@ export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions
 export type { EventMap, EventCallback } from "./lib/utils/events";
 export { JSONOutput, Serializer, type SerializerComponent, SerializeEvent, } from "./lib/serialization";
 export type { SerializeEventData } from "./lib/serialization";
-import * as TypeScript from "typescript";
+import TypeScript from "typescript";
 export { TypeScript };

package/dist/index.js

@@ -13,6 +13,9 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TypeScript = exports.SerializeEvent = exports.Serializer = exports.JSONOutput = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.normalizePath = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
 var application_1 = require("./lib/application");
@@ -57,5 +60,5 @@ var serialization_1 = require("./lib/serialization");
 Object.defineProperty(exports, "JSONOutput", { enumerable: true, get: function () { return serialization_1.JSONOutput; } });
 Object.defineProperty(exports, "Serializer", { enumerable: true, get: function () { return serialization_1.Serializer; } });
 Object.defineProperty(exports, "SerializeEvent", { enumerable: true, get: function () { return serialization_1.SerializeEvent; } });
-const TypeScript = require("typescript");
-exports.TypeScript = TypeScript;
+const typescript_1 = __importDefault(require("typescript"));
+exports.TypeScript = typescript_1.default;

package/dist/lib/application-events.d.ts

@@ -1,3 +1,4 @@
 export declare const ApplicationEvents: {
     BOOTSTRAP_END: string;
+    VALIDATE_PROJECT: string;
 };

package/dist/lib/application-events.js

@@ -3,4 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApplicationEvents = void 0;
 exports.ApplicationEvents = {
     BOOTSTRAP_END: "bootstrapEnd",
+    VALIDATE_PROJECT: "validateProject",
 };

package/dist/lib/application.d.ts

@@ -52,10 +52,13 @@ export declare class Application extends ChildableComponent<Application, Abstrac
      * passed to `bootstrap`.
      */
     static readonly EVENT_BOOTSTRAP_END: string;
+    /**
+     * Emitted when validation is being run.
+     * The listener will be given an instance of {@link ProjectReflection}.
+     */
+    static readonly EVENT_VALIDATE_PROJECT: string;
     /**
      * Create a new TypeDoc application instance.
-     *
-     * @param options An object containing the options that should be used.
      */
     constructor();
     /**

package/dist/lib/application.js

@@ -1,15 +1,41 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 var Application_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Application = void 0;
-const Path = require("path");
-const ts = require("typescript");
+const Path = __importStar(require("path"));
+const typescript_1 = __importDefault(require("typescript"));
 const index_1 = require("./converter/index");
 const renderer_1 = require("./output/renderer");
 const serialization_1 = require("./serialization");
@@ -46,8 +72,6 @@ const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
 let Application = Application_1 = class Application extends component_1.ChildableComponent {
     /**
      * Create a new TypeDoc application instance.
-     *
-     * @param options An object containing the options that should be used.
      */
     constructor() {
         super(null); // We own ourselves
@@ -108,7 +132,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         return (0, paths_1.nicePath)(Path.dirname(require.resolve("typescript")));
     }
     getTypeScriptVersion() {
-        return ts.version;
+        return typescript_1.default.version;
     }
     /**
      * Gets the entry points to be documented according to the current `entryPoints` and `entryPointStrategy` options.
@@ -128,7 +152,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         // with a few different settings.
         this.options.freeze();
         this.logger.verbose(`Using TypeScript ${this.getTypeScriptVersion()} from ${this.getTypeScriptPath()}`);
-        if (!supportedVersionMajorMinor.some((version) => version == ts.versionMajorMinor)) {
+        if (!supportedVersionMajorMinor.some((version) => version == typescript_1.default.versionMajorMinor)) {
             this.logger.warn(`You are running with an unsupported TypeScript version! If TypeDoc crashes, this is why. TypeDoc supports ${supportedVersionMajorMinor.join(", ")}`);
         }
         const entryPoints = this.getEntryPoints();
@@ -139,7 +163,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         const programs = (0, array_1.unique)(entryPoints.map((e) => e.program));
         this.logger.verbose(`Converting with ${programs.length} programs ${entryPoints.length} entry points`);
         if (this.skipErrorChecking === false) {
-            const errors = programs.flatMap((program) => ts.getPreEmitDiagnostics(program));
+            const errors = programs.flatMap((program) => typescript_1.default.getPreEmitDiagnostics(program));
             if (errors.length) {
                 this.logger.diagnostics(errors);
                 return;
@@ -160,10 +184,10 @@ let Application = Application_1 = class Application extends component_1.Childabl
         this.options.freeze();
         if (!this.options.getValue("preserveWatchOutput") &&
             this.logger instanceof index_2.ConsoleLogger) {
-            ts.sys.clearScreen?.();
+            typescript_1.default.sys.clearScreen?.();
         }
         this.logger.verbose(`Using TypeScript ${this.getTypeScriptVersion()} from ${this.getTypeScriptPath()}`);
-        if (!supportedVersionMajorMinor.some((version) => version == ts.versionMajorMinor)) {
+        if (!supportedVersionMajorMinor.some((version) => version == typescript_1.default.versionMajorMinor)) {
             this.logger.warn(`You are running with an unsupported TypeScript version! TypeDoc supports ${supportedVersionMajorMinor.join(", ")}`);
         }
         if (Object.keys(this.options.getCompilerOptions()).length === 0) {
@@ -186,15 +210,15 @@ let Application = Application_1 = class Application extends component_1.Childabl
         // We don't want to do it the first time to preserve initial debug status messages. They'll be lost
         // after the user saves a file, but better than nothing...
         let firstStatusReport = true;
-        const host = ts.createWatchCompilerHost(tsconfigFile, {}, ts.sys, ts.createEmitAndSemanticDiagnosticsBuilderProgram, (diagnostic) => this.logger.diagnostic(diagnostic), (status, newLine, _options, errorCount) => {
+        const host = typescript_1.default.createWatchCompilerHost(tsconfigFile, {}, typescript_1.default.sys, typescript_1.default.createEmitAndSemanticDiagnosticsBuilderProgram, (diagnostic) => this.logger.diagnostic(diagnostic), (status, newLine, _options, errorCount) => {
             if (!firstStatusReport &&
                 errorCount === void 0 &&
                 !this.options.getValue("preserveWatchOutput") &&
                 this.logger instanceof index_2.ConsoleLogger) {
-                ts.sys.clearScreen?.();
+                typescript_1.default.sys.clearScreen?.();
             }
             firstStatusReport = false;
-            this.logger.info(ts.flattenDiagnosticMessageText(status.messageText, newLine));
+            this.logger.info(typescript_1.default.flattenDiagnosticMessageText(status.messageText, newLine));
         });
         let successFinished = true;
         let currentProgram;
@@ -231,13 +255,13 @@ let Application = Application_1 = class Application extends component_1.Childabl
         };
         const origAfterProgramCreate = host.afterProgramCreate;
         host.afterProgramCreate = (program) => {
-            if (ts.getPreEmitDiagnostics(program.getProgram()).length === 0) {
+            if (typescript_1.default.getPreEmitDiagnostics(program.getProgram()).length === 0) {
                 currentProgram = program.getProgram();
                 runSuccess();
             }
             origAfterProgramCreate?.(program);
         };
-        ts.createWatchProgram(host);
+        typescript_1.default.createWatchProgram(host);
     }
     validate(project) {
         const checks = this.options.getValue("validation");
@@ -251,6 +275,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         if (checks.invalidLink) {
             (0, links_1.validateLinks)(project, this.logger);
         }
+        this.trigger(Application_1.EVENT_VALIDATE_PROJECT, project);
         this.logger.verbose(`Validation took ${Date.now() - start}ms`);
     }
     /**
@@ -312,6 +337,11 @@ Application.VERSION = packageInfo.version;
  * passed to `bootstrap`.
  */
 Application.EVENT_BOOTSTRAP_END = application_events_1.ApplicationEvents.BOOTSTRAP_END;
+/**
+ * Emitted when validation is being run.
+ * The listener will be given an instance of {@link ProjectReflection}.
+ */
+Application.EVENT_VALIDATE_PROJECT = application_events_1.ApplicationEvents.VALIDATE_PROJECT;
 __decorate([
     (0, utils_1.BindOption)("logger")
 ], Application.prototype, "loggerType", void 0);

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

@@ -1,4 +1,4 @@
-import * as ts from "typescript";
+import ts from "typescript";
 import { ReflectionKind } from "../../models";
 import { Logger } from "../../utils";
 import { CommentStyle } from "../../utils/options/declaration";

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

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.discoverSignatureComment = exports.discoverComment = void 0;
-const ts = require("typescript");
+const typescript_1 = __importDefault(require("typescript"));
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 const declaration_1 = require("../../utils/options/declaration");
@@ -11,84 +14,84 @@ const paths_1 = require("../../utils/paths");
 // the JSDoc converter because we only want part of the comment when
 // getting them.
 const wantedKinds = {
-    [models_1.ReflectionKind.Project]: [ts.SyntaxKind.SourceFile],
-    [models_1.ReflectionKind.Module]: [ts.SyntaxKind.SourceFile],
+    [models_1.ReflectionKind.Project]: [typescript_1.default.SyntaxKind.SourceFile],
+    [models_1.ReflectionKind.Module]: [typescript_1.default.SyntaxKind.SourceFile],
     [models_1.ReflectionKind.Namespace]: [
-        ts.SyntaxKind.ModuleDeclaration,
-        ts.SyntaxKind.SourceFile,
-        ts.SyntaxKind.BindingElement,
-        ts.SyntaxKind.ExportSpecifier,
-        ts.SyntaxKind.NamespaceExport,
+        typescript_1.default.SyntaxKind.ModuleDeclaration,
+        typescript_1.default.SyntaxKind.SourceFile,
+        typescript_1.default.SyntaxKind.BindingElement,
+        typescript_1.default.SyntaxKind.ExportSpecifier,
+        typescript_1.default.SyntaxKind.NamespaceExport,
     ],
     [models_1.ReflectionKind.Enum]: [
-        ts.SyntaxKind.EnumDeclaration,
-        ts.SyntaxKind.VariableDeclaration,
+        typescript_1.default.SyntaxKind.EnumDeclaration,
+        typescript_1.default.SyntaxKind.VariableDeclaration,
     ],
     [models_1.ReflectionKind.EnumMember]: [
-        ts.SyntaxKind.EnumMember,
+        typescript_1.default.SyntaxKind.EnumMember,
         // These here so that @enum gets comments
-        ts.SyntaxKind.PropertyAssignment,
-        ts.SyntaxKind.PropertySignature,
+        typescript_1.default.SyntaxKind.PropertyAssignment,
+        typescript_1.default.SyntaxKind.PropertySignature,
     ],
     [models_1.ReflectionKind.Variable]: [
-        ts.SyntaxKind.VariableDeclaration,
-        ts.SyntaxKind.BindingElement,
-        ts.SyntaxKind.ExportAssignment,
-        ts.SyntaxKind.PropertyAccessExpression,
+        typescript_1.default.SyntaxKind.VariableDeclaration,
+        typescript_1.default.SyntaxKind.BindingElement,
+        typescript_1.default.SyntaxKind.ExportAssignment,
+        typescript_1.default.SyntaxKind.PropertyAccessExpression,
     ],
     [models_1.ReflectionKind.Function]: [
-        ts.SyntaxKind.FunctionDeclaration,
-        ts.SyntaxKind.BindingElement,
-        ts.SyntaxKind.VariableDeclaration,
-        ts.SyntaxKind.ExportAssignment,
-        ts.SyntaxKind.PropertyAccessExpression,
+        typescript_1.default.SyntaxKind.FunctionDeclaration,
+        typescript_1.default.SyntaxKind.BindingElement,
+        typescript_1.default.SyntaxKind.VariableDeclaration,
+        typescript_1.default.SyntaxKind.ExportAssignment,
+        typescript_1.default.SyntaxKind.PropertyAccessExpression,
     ],
     [models_1.ReflectionKind.Class]: [
-        ts.SyntaxKind.ClassDeclaration,
-        ts.SyntaxKind.BindingElement,
+        typescript_1.default.SyntaxKind.ClassDeclaration,
+        typescript_1.default.SyntaxKind.BindingElement,
     ],
-    [models_1.ReflectionKind.Interface]: [ts.SyntaxKind.InterfaceDeclaration],
-    [models_1.ReflectionKind.Constructor]: [ts.SyntaxKind.Constructor],
+    [models_1.ReflectionKind.Interface]: [typescript_1.default.SyntaxKind.InterfaceDeclaration],
+    [models_1.ReflectionKind.Constructor]: [typescript_1.default.SyntaxKind.Constructor],
     [models_1.ReflectionKind.Property]: [
-        ts.SyntaxKind.PropertyDeclaration,
-        ts.SyntaxKind.PropertySignature,
-        ts.SyntaxKind.BinaryExpression,
-        ts.SyntaxKind.PropertyAssignment,
+        typescript_1.default.SyntaxKind.PropertyDeclaration,
+        typescript_1.default.SyntaxKind.PropertySignature,
+        typescript_1.default.SyntaxKind.BinaryExpression,
+        typescript_1.default.SyntaxKind.PropertyAssignment,
         // class X { constructor(/** Comment */ readonly z: string) }
-        ts.SyntaxKind.Parameter,
+        typescript_1.default.SyntaxKind.Parameter,
     ],
     [models_1.ReflectionKind.Method]: [
-        ts.SyntaxKind.FunctionDeclaration,
-        ts.SyntaxKind.MethodDeclaration,
+        typescript_1.default.SyntaxKind.FunctionDeclaration,
+        typescript_1.default.SyntaxKind.MethodDeclaration,
     ],
     [models_1.ReflectionKind.CallSignature]: [
-        ts.SyntaxKind.FunctionDeclaration,
-        ts.SyntaxKind.VariableDeclaration,
-        ts.SyntaxKind.MethodDeclaration,
-        ts.SyntaxKind.MethodDeclaration,
-        ts.SyntaxKind.PropertyDeclaration,
-        ts.SyntaxKind.PropertySignature,
-        ts.SyntaxKind.CallSignature,
+        typescript_1.default.SyntaxKind.FunctionDeclaration,
+        typescript_1.default.SyntaxKind.VariableDeclaration,
+        typescript_1.default.SyntaxKind.MethodDeclaration,
+        typescript_1.default.SyntaxKind.MethodDeclaration,
+        typescript_1.default.SyntaxKind.PropertyDeclaration,
+        typescript_1.default.SyntaxKind.PropertySignature,
+        typescript_1.default.SyntaxKind.CallSignature,
     ],
-    [models_1.ReflectionKind.IndexSignature]: [ts.SyntaxKind.IndexSignature],
-    [models_1.ReflectionKind.ConstructorSignature]: [ts.SyntaxKind.ConstructSignature],
-    [models_1.ReflectionKind.Parameter]: [ts.SyntaxKind.Parameter],
-    [models_1.ReflectionKind.TypeLiteral]: [ts.SyntaxKind.TypeLiteral],
-    [models_1.ReflectionKind.TypeParameter]: [ts.SyntaxKind.TypeParameter],
-    [models_1.ReflectionKind.Accessor]: [ts.SyntaxKind.PropertyDeclaration],
-    [models_1.ReflectionKind.GetSignature]: [ts.SyntaxKind.GetAccessor],
-    [models_1.ReflectionKind.SetSignature]: [ts.SyntaxKind.SetAccessor],
-    [models_1.ReflectionKind.ObjectLiteral]: [ts.SyntaxKind.ObjectLiteralExpression],
-    [models_1.ReflectionKind.TypeAlias]: [ts.SyntaxKind.TypeAliasDeclaration],
+    [models_1.ReflectionKind.IndexSignature]: [typescript_1.default.SyntaxKind.IndexSignature],
+    [models_1.ReflectionKind.ConstructorSignature]: [typescript_1.default.SyntaxKind.ConstructSignature],
+    [models_1.ReflectionKind.Parameter]: [typescript_1.default.SyntaxKind.Parameter],
+    [models_1.ReflectionKind.TypeLiteral]: [typescript_1.default.SyntaxKind.TypeLiteral],
+    [models_1.ReflectionKind.TypeParameter]: [typescript_1.default.SyntaxKind.TypeParameter],
+    [models_1.ReflectionKind.Accessor]: [typescript_1.default.SyntaxKind.PropertyDeclaration],
+    [models_1.ReflectionKind.GetSignature]: [typescript_1.default.SyntaxKind.GetAccessor],
+    [models_1.ReflectionKind.SetSignature]: [typescript_1.default.SyntaxKind.SetAccessor],
+    [models_1.ReflectionKind.ObjectLiteral]: [typescript_1.default.SyntaxKind.ObjectLiteralExpression],
+    [models_1.ReflectionKind.TypeAlias]: [typescript_1.default.SyntaxKind.TypeAliasDeclaration],
     [models_1.ReflectionKind.Reference]: [
-        ts.SyntaxKind.NamespaceExport,
-        ts.SyntaxKind.ExportSpecifier,
+        typescript_1.default.SyntaxKind.NamespaceExport,
+        typescript_1.default.SyntaxKind.ExportSpecifier,
     ],
 };
 function discoverComment(symbol, kind, logger, commentStyle) {
     // For a module comment, we want the first one defined in the file,
     // not the last one, since that will apply to the import or declaration.
-    const reverse = !symbol.declarations?.some(ts.isSourceFile);
+    const reverse = !symbol.declarations?.some(typescript_1.default.isSourceFile);
     const discovered = [];
     for (const decl of symbol.declarations || []) {
         const text = decl.getSourceFile().text;
@@ -104,14 +107,14 @@ function discoverComment(symbol, kind, logger, commentStyle) {
             // See the gh1770 test for an example.
             if (kind & models_1.ReflectionKind.ContainsCallSignatures &&
                 [
-                    ts.SyntaxKind.FunctionDeclaration,
-                    ts.SyntaxKind.MethodDeclaration,
-                    ts.SyntaxKind.Constructor,
+                    typescript_1.default.SyntaxKind.FunctionDeclaration,
+                    typescript_1.default.SyntaxKind.MethodDeclaration,
+                    typescript_1.default.SyntaxKind.Constructor,
                 ].includes(node.kind) &&
                 !node.body) {
                 continue;
             }
-            const comments = collectCommentRanges(ts.getLeadingCommentRanges(text, node.pos));
+            const comments = collectCommentRanges(typescript_1.default.getLeadingCommentRanges(text, node.pos));
             if (reverse) {
                 comments.reverse();
             }
@@ -130,7 +133,7 @@ function discoverComment(symbol, kind, logger, commentStyle) {
             logger.warn(`${symbol.name} has multiple declarations with a comment. An arbitrary comment will be used.`);
             const locations = discovered.map(([sf, [{ pos }]]) => {
                 const path = (0, paths_1.nicePath)(sf.fileName);
-                const line = ts.getLineAndCharacterOfPosition(sf, pos).line + 1;
+                const line = typescript_1.default.getLineAndCharacterOfPosition(sf, pos).line + 1;
                 return `${path}:${line}`;
             });
             logger.info(`The comments for ${symbol.name} are declared at:\n\t${locations.join("\n\t")}`);
@@ -145,7 +148,7 @@ function discoverSignatureComment(declaration, commentStyle) {
         return;
     }
     const text = node.getSourceFile().text;
-    const comments = collectCommentRanges(ts.getLeadingCommentRanges(text, node.pos));
+    const comments = collectCommentRanges(typescript_1.default.getLeadingCommentRanges(text, node.pos));
     comments.reverse();
     const comment = comments.find((ranges) => permittedRange(text, ranges, commentStyle));
     if (comment) {
@@ -167,7 +170,7 @@ exports.discoverSignatureComment = discoverSignatureComment;
  * @return TRUE if the given node is the topmost module declaration, FALSE otherwise.
  */
 function isTopmostModuleDeclaration(node) {
-    return node.getChildren().some(ts.isModuleBlock);
+    return node.getChildren().some(typescript_1.default.isModuleBlock);
 }
 /**
  * Return the root module declaration of the given module declaration.
@@ -181,7 +184,7 @@ function isTopmostModuleDeclaration(node) {
  */
 function getRootModuleDeclaration(node) {
     while (node.parent &&
-        node.parent.kind === ts.SyntaxKind.ModuleDeclaration) {
+        node.parent.kind === typescript_1.default.SyntaxKind.ModuleDeclaration) {
         const parent = node.parent;
         if (node.name.pos === parent.name.end + 1) {
             node = parent;
@@ -197,12 +200,12 @@ function declarationToCommentNode(node) {
         return node;
     // const abc = 123
     //       ^^^
-    if (node.parent.kind === ts.SyntaxKind.VariableDeclarationList) {
+    if (node.parent.kind === typescript_1.default.SyntaxKind.VariableDeclarationList) {
         return node.parent.parent;
     }
     // const a = () => {}
     //           ^^^^^^^^
-    if (node.parent.kind === ts.SyntaxKind.VariableDeclaration) {
+    if (node.parent.kind === typescript_1.default.SyntaxKind.VariableDeclaration) {
         return node.parent.parent.parent;
     }
     // class X { y = () => {} }
@@ -213,13 +216,13 @@ function declarationToCommentNode(node) {
     // export default () => {}
     //                ^^^^^^^^
     if ([
-        ts.SyntaxKind.PropertyDeclaration,
-        ts.SyntaxKind.BinaryExpression,
-        ts.SyntaxKind.ExportAssignment,
+        typescript_1.default.SyntaxKind.PropertyDeclaration,
+        typescript_1.default.SyntaxKind.BinaryExpression,
+        typescript_1.default.SyntaxKind.ExportAssignment,
     ].includes(node.parent.kind)) {
         return node.parent;
     }
-    if (ts.isModuleDeclaration(node)) {
+    if (typescript_1.default.isModuleDeclaration(node)) {
         if (!isTopmostModuleDeclaration(node)) {
             return;
         }
@@ -227,10 +230,10 @@ function declarationToCommentNode(node) {
             return getRootModuleDeclaration(node);
         }
     }
-    if (node.kind === ts.SyntaxKind.ExportSpecifier) {
+    if (node.kind === typescript_1.default.SyntaxKind.ExportSpecifier) {
         return node.parent.parent;
     }
-    if ([ts.SyntaxKind.NamespaceExport, ts.SyntaxKind.FunctionType].includes(node.kind)) {
+    if ([typescript_1.default.SyntaxKind.NamespaceExport, typescript_1.default.SyntaxKind.FunctionType].includes(node.kind)) {
         return node.parent;
     }
     return node;
@@ -245,14 +248,14 @@ function collectCommentRanges(ranges) {
     for (const range of ranges || []) {
         collect.push(range);
         switch (range.kind) {
-            case ts.SyntaxKind.MultiLineCommentTrivia:
+            case typescript_1.default.SyntaxKind.MultiLineCommentTrivia:
                 if (collect.length) {
                     result.push(collect);
                     collect = [];
                 }
                 result.push([range]);
                 break;
-            case ts.SyntaxKind.SingleLineCommentTrivia:
+            case typescript_1.default.SyntaxKind.SingleLineCommentTrivia:
                 collect.push(range);
                 break;
             /* istanbul ignore next */
@@ -270,11 +273,11 @@ function permittedRange(text, ranges, commentStyle) {
         case declaration_1.CommentStyle.All:
             return true;
         case declaration_1.CommentStyle.Block:
-            return ranges[0].kind === ts.SyntaxKind.MultiLineCommentTrivia;
+            return ranges[0].kind === typescript_1.default.SyntaxKind.MultiLineCommentTrivia;
         case declaration_1.CommentStyle.Line:
-            return ranges[0].kind === ts.SyntaxKind.SingleLineCommentTrivia;
+            return ranges[0].kind === typescript_1.default.SyntaxKind.SingleLineCommentTrivia;
         case declaration_1.CommentStyle.JSDoc:
-            return (ranges[0].kind === ts.SyntaxKind.MultiLineCommentTrivia &&
+            return (ranges[0].kind === typescript_1.default.SyntaxKind.MultiLineCommentTrivia &&
                 text[ranges[0].pos] === "/" &&
                 text[ranges[0].pos + 1] === "*" &&
                 text[ranges[0].pos + 2] === "*");

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

@@ -1,4 +1,4 @@
-import * as ts from "typescript";
+import ts from "typescript";
 import { Comment, ReflectionKind } from "../../models";
 import { Logger } from "../../utils";
 import type { CommentStyle } from "../../utils/options/declaration";

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

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getJsDocComment = exports.getSignatureComment = exports.getComment = void 0;
-const ts = require("typescript");
+const typescript_1 = __importDefault(require("typescript"));
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 const blockLexer_1 = require("./blockLexer");
@@ -9,11 +12,11 @@ const discovery_1 = require("./discovery");
 const lineLexer_1 = require("./lineLexer");
 const parser_1 = require("./parser");
 const jsDocCommentKinds = [
-    ts.SyntaxKind.JSDocPropertyTag,
-    ts.SyntaxKind.JSDocCallbackTag,
-    ts.SyntaxKind.JSDocTypedefTag,
-    ts.SyntaxKind.JSDocTemplateTag,
-    ts.SyntaxKind.JSDocEnumTag,
+    typescript_1.default.SyntaxKind.JSDocPropertyTag,
+    typescript_1.default.SyntaxKind.JSDocCallbackTag,
+    typescript_1.default.SyntaxKind.JSDocTypedefTag,
+    typescript_1.default.SyntaxKind.JSDocTemplateTag,
+    typescript_1.default.SyntaxKind.JSDocEnumTag,
 ];
 const commentCache = new WeakMap();
 function getCommentWithCache(discovered, config, logger) {
@@ -26,10 +29,10 @@ function getCommentWithCache(discovered, config, logger) {
     }
     let comment;
     switch (ranges[0].kind) {
-        case ts.SyntaxKind.MultiLineCommentTrivia:
+        case typescript_1.default.SyntaxKind.MultiLineCommentTrivia:
             comment = (0, parser_1.parseComment)((0, blockLexer_1.lexBlockComment)(file.text, ranges[0].pos, ranges[0].end), config, file, logger);
             break;
-        case ts.SyntaxKind.SingleLineCommentTrivia:
+        case typescript_1.default.SyntaxKind.SingleLineCommentTrivia:
             comment = (0, parser_1.parseComment)((0, lineLexer_1.lexLineComments)(file.text, ranges), config, file, logger);
             break;
         default:
@@ -59,12 +62,12 @@ function getCommentImpl(commentSource, config, logger, moduleComment) {
     return comment;
 }
 function getComment(symbol, kind, config, logger, commentStyle) {
-    if (symbol
-        .getDeclarations()
-        ?.every((d) => jsDocCommentKinds.includes(d.kind))) {
-        return getJsDocComment(symbol.declarations[0], config, logger);
+    const declarations = symbol.declarations || [];
+    if (declarations.length &&
+        declarations.every((d) => jsDocCommentKinds.includes(d.kind))) {
+        return getJsDocComment(declarations[0], config, logger);
     }
-    const comment = getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger, symbol.declarations?.some(ts.isSourceFile) || false);
+    const comment = getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger, declarations.some(typescript_1.default.isSourceFile));
     if (!comment && kind === models_1.ReflectionKind.Property) {
         return getConstructorParamPropertyComment(symbol, config, logger, commentStyle);
     }
@@ -72,7 +75,7 @@ function getComment(symbol, kind, config, logger, commentStyle) {
 }
 exports.getComment = getComment;
 function getConstructorParamPropertyComment(symbol, config, logger, commentStyle) {
-    const decl = symbol.declarations?.find(ts.isParameter);
+    const decl = symbol.declarations?.find(typescript_1.default.isParameter);
     if (!decl)
         return;
     const ctor = decl.parent;
@@ -90,7 +93,7 @@ function getJsDocComment(declaration, config, logger) {
     const file = declaration.getSourceFile();
     // First, get the whole comment. We know we'll need all of it.
     let parent = declaration.parent;
-    while (!ts.isJSDoc(parent)) {
+    while (!typescript_1.default.isJSDoc(parent)) {
         parent = parent.parent;
     }
     // Then parse it.
@@ -98,17 +101,17 @@ function getJsDocComment(declaration, config, logger) {
         file,
         [
             {
-                kind: ts.SyntaxKind.MultiLineCommentTrivia,
+                kind: typescript_1.default.SyntaxKind.MultiLineCommentTrivia,
                 pos: parent.pos,
                 end: parent.end,
             },
         ],
     ], config, logger);
     // And pull out the tag we actually care about.
-    if (ts.isJSDocEnumTag(declaration)) {
+    if (typescript_1.default.isJSDocEnumTag(declaration)) {
         return new models_1.Comment(comment.getTag("@enum")?.content);
     }
-    if (ts.isJSDocTemplateTag(declaration) &&
+    if (typescript_1.default.isJSDocTemplateTag(declaration) &&
         declaration.comment &&
         declaration.typeParameters.length > 1) {
         // We could just put the same comment on everything, but due to how comment parsing works,
@@ -118,7 +121,7 @@ function getJsDocComment(declaration, config, logger) {
         return;
     }
     let name;
-    if (ts.isJSDocTemplateTag(declaration)) {
+    if (typescript_1.default.isJSDocTemplateTag(declaration)) {
         // This isn't really ideal.
         name = declaration.typeParameters[0].name.text;
     }

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

@@ -1,5 +1,10 @@
 import { Comment, CommentDisplayPart, Reflection } from "../../models";
 import type { Logger, ValidationOptions } from "../../utils";
 import { DeclarationReference } from "./declarationReference";
-export declare function resolveLinks(comment: Comment, reflection: Reflection, validation: ValidationOptions, logger: Logger, attemptExternalResolve: (ref: DeclarationReference) => string | undefined): void;
-export declare function resolvePartLinks(reflection: Reflection, parts: readonly CommentDisplayPart[], warn: () => void, validation: ValidationOptions, logger: Logger, attemptExternalResolve: (ref: DeclarationReference) => string | undefined): CommentDisplayPart[];
+export type ExternalResolveResult = {
+    target: string;
+    caption?: string;
+};
+export type ExternalSymbolResolver = (ref: DeclarationReference, refl: Reflection, part: Readonly<CommentDisplayPart> | undefined) => ExternalResolveResult | string | undefined;
+export declare function resolveLinks(comment: Comment, reflection: Reflection, validation: ValidationOptions, logger: Logger, externalResolver: ExternalSymbolResolver): void;
+export declare function resolvePartLinks(reflection: Reflection, parts: readonly CommentDisplayPart[], warn: () => void, validation: ValidationOptions, logger: Logger, externalResolver: ExternalSymbolResolver): CommentDisplayPart[];