typedoc 0.24.0-beta.1 → 0.24.0-beta.3

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,30 +1,10 @@
 "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 __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 };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getJsDocComment = exports.getSignatureComment = exports.getComment = void 0;
-const ts = __importStar(require("typescript"));
+const typescript_1 = __importDefault(require("typescript"));
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 const blockLexer_1 = require("./blockLexer");
@@ -32,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) {
@@ -49,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:
@@ -82,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);
     }
@@ -95,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;
@@ -113,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.
@@ -121,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,
@@ -141,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,4 +1,9 @@
 import { Comment, CommentDisplayPart, Reflection } from "../../models";
 import { DeclarationReference } from "./declarationReference";
-export declare function resolveLinks(comment: Comment, reflection: Reflection, attemptExternalResolve: (ref: DeclarationReference) => string | undefined): void;
-export declare function resolvePartLinks(reflection: Reflection, parts: readonly CommentDisplayPart[], 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, externalResolver: ExternalSymbolResolver): void;
+export declare function resolvePartLinks(reflection: Reflection, parts: readonly CommentDisplayPart[], externalResolver: ExternalSymbolResolver): CommentDisplayPart[];

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

@@ -1,68 +1,48 @@
 "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 __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 };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolvePartLinks = exports.resolveLinks = void 0;
-const ts = __importStar(require("typescript"));
+const typescript_1 = __importDefault(require("typescript"));
 const models_1 = require("../../models");
 const declarationReference_1 = require("./declarationReference");
 const declarationReferenceResolver_1 = require("./declarationReferenceResolver");
 const urlPrefix = /^(http|ftp)s?:\/\//;
-function resolveLinks(comment, reflection, attemptExternalResolve) {
-    comment.summary = resolvePartLinks(reflection, comment.summary, attemptExternalResolve);
+function resolveLinks(comment, reflection, externalResolver) {
+    comment.summary = resolvePartLinks(reflection, comment.summary, externalResolver);
     for (const tag of comment.blockTags) {
-        tag.content = resolvePartLinks(reflection, tag.content, attemptExternalResolve);
+        tag.content = resolvePartLinks(reflection, tag.content, externalResolver);
     }
     if (reflection instanceof models_1.DeclarationReflection && reflection.readme) {
-        reflection.readme = resolvePartLinks(reflection, reflection.readme, attemptExternalResolve);
+        reflection.readme = resolvePartLinks(reflection, reflection.readme, externalResolver);
     }
 }
 exports.resolveLinks = resolveLinks;
-function resolvePartLinks(reflection, parts, attemptExternalResolve) {
-    return parts.flatMap((part) => processPart(reflection, part, attemptExternalResolve));
+function resolvePartLinks(reflection, parts, externalResolver) {
+    return parts.flatMap((part) => processPart(reflection, part, externalResolver));
 }
 exports.resolvePartLinks = resolvePartLinks;
-function processPart(reflection, part, attemptExternalResolve) {
+function processPart(reflection, part, externalResolver) {
     if (part.kind === "inline-tag") {
         if (part.tag === "@link" ||
             part.tag === "@linkcode" ||
             part.tag === "@linkplain") {
-            return resolveLinkTag(reflection, part, attemptExternalResolve);
+            return resolveLinkTag(reflection, part, externalResolver);
         }
     }
     return part;
 }
-function resolveLinkTag(reflection, part, attemptExternalResolve) {
+function resolveLinkTag(reflection, part, externalResolver) {
     let pos = 0;
     const end = part.text.length;
-    while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
+    while (pos < end && typescript_1.default.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
         pos++;
     }
     // Try to parse one
     const declRef = (0, declarationReference_1.parseDeclarationReference)(part.text, pos, end);
     let target;
-    let defaultDisplayText;
+    let defaultDisplayText = "";
     if (declRef) {
         // Got one, great! Try to resolve the link
         target = (0, declarationReferenceResolver_1.resolveDeclarationReference)(reflection, declRef[0]);
@@ -72,9 +52,16 @@ function resolveLinkTag(reflection, part, attemptExternalResolve) {
         }
         else {
             // If we didn't find a link, it might be a @link tag to an external symbol, check that next.
-            target = attemptExternalResolve(declRef[0]);
-            if (target) {
-                defaultDisplayText = part.text.substring(0, pos);
+            const externalResolveResult = externalResolver(declRef[0], reflection, part);
+            defaultDisplayText = part.text.substring(0, pos);
+            switch (typeof externalResolveResult) {
+                case "string":
+                    target = externalResolveResult;
+                    break;
+                case "object":
+                    target = externalResolveResult.target;
+                    defaultDisplayText =
+                        externalResolveResult.caption || defaultDisplayText;
             }
         }
     }
@@ -89,7 +76,7 @@ function resolveLinkTag(reflection, part, attemptExternalResolve) {
     }
     // Remaining text after an optional pipe is the link text, so advance
     // until that's consumed.
-    while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
+    while (pos < end && typescript_1.default.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
         pos++;
     }
     if (pos < end && part.text[pos] === "|") {
@@ -99,6 +86,7 @@ function resolveLinkTag(reflection, part, attemptExternalResolve) {
         return part;
     }
     part.target = target;
-    part.text = part.text.substring(pos).trim() || defaultDisplayText;
+    part.text =
+        part.text.substring(pos).trim() || defaultDisplayText || part.text;
     return part;
 }

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

@@ -1,4 +1,4 @@
-import * as ts from "typescript";
+import ts from "typescript";
 import { Reflection, ProjectReflection, DeclarationReflection, ReflectionKind } from "../models/index";
 import type { Converter } from "./converter";
 /**

package/dist/lib/converter/context.js

@@ -1,31 +1,11 @@
 "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 __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 };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Context = void 0;
 const assert_1 = require("assert");
-const ts = __importStar(require("typescript"));
+const typescript_1 = __importDefault(require("typescript"));
 const index_1 = require("../models/index");
 const nodes_1 = require("./utils/nodes");
 const converter_events_1 = require("./converter-events");
@@ -120,8 +100,8 @@ class Context {
     expectSymbolAtLocation(node) {
         const symbol = this.getSymbolAtLocation(node);
         if (!symbol) {
-            const { line } = ts.getLineAndCharacterOfPosition(node.getSourceFile(), node.pos);
-            throw new Error(`Expected a symbol for node with kind ${ts.SyntaxKind[node.kind]} at ${node.getSourceFile().fileName}:${line + 1}`);
+            const { line } = typescript_1.default.getLineAndCharacterOfPosition(node.getSourceFile(), node.pos);
+            throw new Error(`Expected a symbol for node with kind ${typescript_1.default.SyntaxKind[node.kind]} at ${node.getSourceFile().fileName}:${line + 1}`);
         }
         return symbol;
     }

package/dist/lib/converter/convert-expression.d.ts

@@ -1,4 +1,4 @@
-import * as ts from "typescript";
+import ts from "typescript";
 /**
  * Return the default value of the given node.
  *

package/dist/lib/converter/convert-expression.js

@@ -1,30 +1,10 @@
 "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 __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 };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertExpression = exports.convertDefaultValue = void 0;
-const ts = __importStar(require("typescript"));
+const typescript_1 = __importDefault(require("typescript"));
 /**
  * Return the default value of the given node.
  *
@@ -43,32 +23,32 @@ function convertDefaultValue(node) {
 exports.convertDefaultValue = convertDefaultValue;
 function convertExpression(expression) {
     switch (expression.kind) {
-        case ts.SyntaxKind.StringLiteral:
-        case ts.SyntaxKind.TrueKeyword:
-        case ts.SyntaxKind.FalseKeyword:
-        case ts.SyntaxKind.NullKeyword:
-        case ts.SyntaxKind.NumericLiteral:
-        case ts.SyntaxKind.PrefixUnaryExpression:
-        case ts.SyntaxKind.Identifier:
+        case typescript_1.default.SyntaxKind.StringLiteral:
+        case typescript_1.default.SyntaxKind.TrueKeyword:
+        case typescript_1.default.SyntaxKind.FalseKeyword:
+        case typescript_1.default.SyntaxKind.NullKeyword:
+        case typescript_1.default.SyntaxKind.NumericLiteral:
+        case typescript_1.default.SyntaxKind.PrefixUnaryExpression:
+        case typescript_1.default.SyntaxKind.Identifier:
             return expression.getText();
     }
-    if (ts.isArrayLiteralExpression(expression) &&
+    if (typescript_1.default.isArrayLiteralExpression(expression) &&
         expression.elements.length === 0) {
         return "[]";
     }
-    if (ts.isObjectLiteralExpression(expression) &&
+    if (typescript_1.default.isObjectLiteralExpression(expression) &&
         expression.properties.length === 0) {
         return "{}";
     }
     // a.b.c.d
-    if (ts.isPropertyAccessExpression(expression)) {
+    if (typescript_1.default.isPropertyAccessExpression(expression)) {
         const parts = [expression.name.getText()];
         let iter = expression.expression;
-        while (ts.isPropertyAccessExpression(iter)) {
+        while (typescript_1.default.isPropertyAccessExpression(iter)) {
             parts.unshift(iter.name.getText());
             iter = iter.expression;
         }
-        if (ts.isIdentifier(iter)) {
+        if (typescript_1.default.isIdentifier(iter)) {
             parts.unshift(iter.text);
             return parts.join(".");
         }

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

@@ -1,4 +1,4 @@
-import * as ts from "typescript";
+import ts from "typescript";
 import type { Application } from "../application";
 import { Comment, CommentDisplayPart, ProjectReflection, Reflection, SomeType } from "../models/index";
 import { Context } from "./context";
@@ -8,6 +8,7 @@ import { MinimalSourceFile } from "../utils";
 import type { DocumentationEntryPoint } from "../utils/entry-point";
 import { CommentParserConfig } from "./comments";
 import type { CommentStyle, ValidationOptions } from "../utils/options/declaration";
+import { ExternalSymbolResolver, ExternalResolveResult } from "./comments/linkResolver";
 import type { DeclarationReference } from "./comments/declarationReference";
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
@@ -128,12 +129,13 @@ export declare class Converter extends ChildableComponent<Application, Converter
      *
      * Note: This will be used for both references to types declared in node_modules (in which case the
      * reference passed will have the `moduleSource` set and the `symbolReference` will navigate via `.`)
-     * and user defined \{\@link\} tags which cannot be resolved.
+     * and user defined \{\@link\} tags which cannot be resolved. If the link being resolved is inferred
+     * from a type, then no `part` will be passed to the resolver function.
      * @since 0.22.14
      */
-    addUnknownSymbolResolver(resolver: (ref: DeclarationReference) => string | undefined): void;
+    addUnknownSymbolResolver(resolver: ExternalSymbolResolver): void;
     /** @internal */
-    resolveExternalLink(ref: DeclarationReference): string | undefined;
+    resolveExternalLink(ref: DeclarationReference, refl: Reflection, part?: CommentDisplayPart): ExternalResolveResult | string | undefined;
     resolveLinks(comment: Comment, owner: Reflection): void;
     resolveLinks(parts: readonly CommentDisplayPart[], owner: Reflection): CommentDisplayPart[];
     /**

package/dist/lib/converter/converter.js

@@ -1,37 +1,17 @@
 "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 Converter_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Converter = void 0;
-const ts = __importStar(require("typescript"));
+const typescript_1 = __importDefault(require("typescript"));
 const index_1 = require("../models/index");
 const context_1 = require("./context");
 const components_1 = require("./components");
@@ -126,26 +106,27 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
      *
      * Note: This will be used for both references to types declared in node_modules (in which case the
      * reference passed will have the `moduleSource` set and the `symbolReference` will navigate via `.`)
-     * and user defined \{\@link\} tags which cannot be resolved.
+     * and user defined \{\@link\} tags which cannot be resolved. If the link being resolved is inferred
+     * from a type, then no `part` will be passed to the resolver function.
      * @since 0.22.14
      */
     addUnknownSymbolResolver(resolver) {
         this._externalSymbolResolvers.push(resolver);
     }
     /** @internal */
-    resolveExternalLink(ref) {
+    resolveExternalLink(ref, refl, part) {
         for (const resolver of this._externalSymbolResolvers) {
-            const resolved = resolver(ref);
+            const resolved = resolver(ref, refl, part);
             if (resolved)
                 return resolved;
         }
     }
     resolveLinks(comment, owner) {
         if (comment instanceof index_1.Comment) {
-            (0, linkResolver_1.resolveLinks)(comment, owner, (ref) => this.resolveExternalLink(ref));
+            (0, linkResolver_1.resolveLinks)(comment, owner, (ref, part, refl) => this.resolveExternalLink(ref, part, refl));
         }
         else {
-            return (0, linkResolver_1.resolvePartLinks)(owner, comment, (ref) => this.resolveExternalLink(ref));
+            return (0, linkResolver_1.resolvePartLinks)(owner, comment, (ref, part, refl) => this.resolveExternalLink(ref, part, refl));
         }
     }
     /**
@@ -371,15 +352,15 @@ function getSymbolForModuleLike(context, node) {
     // "globals" file, but this is uncommon enough that I'm skipping it for now.
     const sourceFile = node.getSourceFile();
     const globalSymbols = context.checker
-        .getSymbolsInScope(node, ts.SymbolFlags.ModuleMember)
+        .getSymbolsInScope(node, typescript_1.default.SymbolFlags.ModuleMember)
         .filter((s) => s.getDeclarations()?.some((d) => d.getSourceFile() === sourceFile));
     // Detect declaration files with declare module "foo" as their only export
     // and lift that up one level as the source file symbol
     if (globalSymbols.length === 1 &&
         globalSymbols[0]
             .getDeclarations()
-            ?.every((declaration) => ts.isModuleDeclaration(declaration) &&
-            ts.isStringLiteral(declaration.name))) {
+            ?.every((declaration) => typescript_1.default.isModuleDeclaration(declaration) &&
+            typescript_1.default.isStringLiteral(declaration.name))) {
         return globalSymbols[0];
     }
 }
@@ -394,15 +375,15 @@ function getExports(context, node, symbol) {
         // members of the export= class and as functions if a class is directly exported.
         result = [exportEq].concat(context.checker
             .getExportsOfModule(symbol)
-            .filter((s) => !(0, enum_1.hasAnyFlag)(s.flags, ts.SymbolFlags.Prototype | ts.SymbolFlags.Value)));
+            .filter((s) => !(0, enum_1.hasAnyFlag)(s.flags, typescript_1.default.SymbolFlags.Prototype | typescript_1.default.SymbolFlags.Value)));
     }
     else if (symbol) {
         result = context.checker
             .getExportsOfModule(symbol)
-            .filter((s) => !(0, enum_1.hasAllFlags)(s.flags, ts.SymbolFlags.Prototype));
+            .filter((s) => !(0, enum_1.hasAllFlags)(s.flags, typescript_1.default.SymbolFlags.Prototype));
         if (result.length === 0) {
-            const globalDecl = node.statements.find((s) => ts.isModuleDeclaration(s) &&
-                s.flags & ts.NodeFlags.GlobalAugmentation);
+            const globalDecl = node.statements.find((s) => typescript_1.default.isModuleDeclaration(s) &&
+                s.flags & typescript_1.default.NodeFlags.GlobalAugmentation);
             if (globalDecl) {
                 const globalSymbol = context.getSymbolAtLocation(globalDecl);
                 if (globalSymbol) {
@@ -417,7 +398,7 @@ function getExports(context, node, symbol) {
         // Global file with no inferred top level symbol, get all symbols declared in this file.
         const sourceFile = node.getSourceFile();
         result = context.checker
-            .getSymbolsInScope(node, ts.SymbolFlags.ModuleMember)
+            .getSymbolsInScope(node, typescript_1.default.SymbolFlags.ModuleMember)
             .filter((s) => s
             .getDeclarations()
             ?.some((d) => d.getSourceFile() === sourceFile));

package/dist/lib/converter/factories/index-signature.d.ts

@@ -1,3 +1,3 @@
-import * as ts from "typescript";
+import ts from "typescript";
 import type { Context } from "../context";
 export declare function convertIndexSignature(context: Context, symbol: ts.Symbol): void;

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

@@ -1,34 +1,11 @@
 "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 __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 };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertIndexSignature = void 0;
 const assert_1 = __importDefault(require("assert"));
-const ts = __importStar(require("typescript"));
+const typescript_1 = __importDefault(require("typescript"));
 const models_1 = require("../../models");
 const converter_events_1 = require("../converter-events");
 function convertIndexSignature(context, symbol) {
@@ -39,9 +16,9 @@ function convertIndexSignature(context, symbol) {
         // and number index signatures... { [x: string]: 1 | 2; [x: number]: 2 }
         // will be misrepresented.
         const indexDeclaration = indexSymbol.getDeclarations()?.[0];
-        (0, assert_1.default)(indexDeclaration && ts.isIndexSignatureDeclaration(indexDeclaration));
+        (0, assert_1.default)(indexDeclaration && typescript_1.default.isIndexSignatureDeclaration(indexDeclaration));
         const param = indexDeclaration.parameters[0];
-        (0, assert_1.default)(param && ts.isParameter(param));
+        (0, assert_1.default)(param && typescript_1.default.isParameter(param));
         const index = new models_1.SignatureReflection("__index", models_1.ReflectionKind.IndexSignature, context.scope);
         index.parameters = [
             new models_1.ParameterReflection(param.name.getText(), models_1.ReflectionKind.Parameter, index),

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

@@ -1,4 +1,4 @@
-import * as ts from "typescript";
+import ts from "typescript";
 import { ParameterReflection, ReflectionKind, SignatureReflection, TypeParameterReflection } from "../../models";
 import type { Context } from "../context";
 export declare function createSignature(context: Context, kind: ReflectionKind.CallSignature | ReflectionKind.ConstructorSignature | ReflectionKind.GetSignature | ReflectionKind.SetSignature, signature: ts.Signature, symbol: ts.Symbol | undefined, declaration?: ts.SignatureDeclaration | ts.JSDocSignature): void;