typedoc 0.26.6 → 0.26.7

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

@@ -1,4 +1,4 @@
-import { type Comment, type CommentDisplayPart, type Reflection, ReflectionSymbolId } from "../../models";
+import { type Comment, type CommentDisplayPart, Reflection, ReflectionSymbolId } from "../../models";
 import { type DeclarationReference } from "./declarationReference";
 export type ExternalResolveResult = {
     target: string;

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

@@ -36,6 +36,11 @@ function processPart(reflection, part, externalResolver, options) {
     return part;
 }
 function resolveLinkTag(reflection, part, externalResolver, options) {
+    // This tag may have already been resolved to if we are running in packages mode
+    // or when reading in a JSON file. #2680.
+    if (typeof part.target === "string" || part.target instanceof models_1.Reflection) {
+        return part;
+    }
     let defaultDisplayText = "";
     let pos = 0;
     const end = part.text.length;

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

@@ -100,6 +100,10 @@ function createConstructSignatureWithType(context, signature, classType) {
     context.converter.trigger(converter_events_1.ConverterEvents.CREATE_SIGNATURE, context, sigRef, declaration, signature);
 }
 function convertParameters(context, sigRef, parameters, parameterNodes) {
+    // #2698 if `satisfies` is used to imply a this parameter, we might have
+    // more parameters than parameter nodes and need to shift the parameterNode
+    // access index. Very ugly, but it does the job.
+    const parameterNodeOffset = parameterNodes?.length !== parameters.length ? -1 : 0;
     return parameters.map((param, i) => {
         const declaration = param.valueDeclaration;
         (0, assert_1.default)(!declaration ||
@@ -139,7 +143,7 @@ function convertParameters(context, sigRef, parameters, parameterNodes) {
         if (isOptional) {
             paramRefl.type = (0, reflections_1.removeUndefined)(paramRefl.type);
         }
-        paramRefl.defaultValue = (0, convert_expression_1.convertDefaultValue)(parameterNodes?.[i]);
+        paramRefl.defaultValue = (0, convert_expression_1.convertDefaultValue)(parameterNodes?.[i + parameterNodeOffset]);
         paramRefl.setFlag(models_1.ReflectionFlag.Optional, isOptional);
         // If we have no declaration, then this is an implicitly defined parameter in JS land
         // because the method body uses `arguments`... which is always a rest argument
@@ -151,7 +155,7 @@ function convertParameters(context, sigRef, parameters, parameterNodes) {
                     typescript_1.default.isJSDocVariadicType(declaration.typeExpression.type);
         }
         paramRefl.setFlag(models_1.ReflectionFlag.Rest, isRest);
-        checkForDestructuredParameterDefaults(paramRefl, parameterNodes?.[i]);
+        checkForDestructuredParameterDefaults(paramRefl, parameterNodes?.[i + parameterNodeOffset]);
         return paramRefl;
     });
 }

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

@@ -237,6 +237,15 @@ let CommentPlugin = (() => {
             if (reflection.kindOf(models_1.ReflectionKind.Interface)) {
                 comment.removeModifier("@interface");
             }
+            if (comment.hasModifier("@abstract")) {
+                if (reflection.kindOf(models_1.ReflectionKind.SomeSignature)) {
+                    reflection.parent.setFlag(models_1.ReflectionFlag.Abstract);
+                }
+                else {
+                    reflection.setFlag(models_1.ReflectionFlag.Abstract);
+                }
+                comment.removeModifier("@abstract");
+            }
             if (comment.hasModifier("@private")) {
                 reflection.setFlag(models_1.ReflectionFlag.Private);
                 if (reflection.kindOf(models_1.ReflectionKind.CallSignature)) {
@@ -406,12 +415,14 @@ let CommentPlugin = (() => {
                     reflection.comment.removeModifier("@hideconstructor");
                 }
             }
-            if (reflection instanceof models_1.DeclarationReflection && reflection.comment) {
-                let sigs;
+            if ((reflection instanceof models_1.DeclarationReflection ||
+                reflection instanceof models_1.ParameterReflection) &&
+                reflection.comment) {
+                let sigs = [];
                 if (reflection.type instanceof models_1.ReflectionType) {
                     sigs = reflection.type.declaration.getNonIndexSignatures();
                 }
-                else {
+                else if (reflection instanceof models_1.DeclarationReflection) {
                     sigs = reflection.getNonIndexSignatures();
                 }
                 // For variables and properties, the symbol might own the comment but we might also

package/dist/lib/internationalization/translatable.d.ts

@@ -76,6 +76,7 @@ export declare const translatable: {
     readonly disable_git_set_and_git_revision_used: "disableGit is set and sourceLinkTemplate contains {gitRevision}, which will be replaced with an empty string as no revision was provided";
     readonly git_remote_0_not_valid: "The provided git remote \"{0}\" was not valid. Source links will be broken";
     readonly custom_css_file_0_does_not_exist: "Custom CSS file at {0} does not exist";
+    readonly custom_js_file_0_does_not_exist: "Custom JavaScript file at {0} does not exist";
     readonly unsupported_highlight_language_0_not_highlighted_in_comment_for_1: "Unsupported highlight language {0} will not be highlighted in comment for {1}";
     readonly unloaded_language_0_not_highlighted_in_comment_for_1: "Code block with language {0} will not be highlighted in comment for {1} as it was not included in the highlightLanguages option";
     readonly yaml_frontmatter_not_an_object: "Expected YAML frontmatter to be an object";
@@ -144,6 +145,7 @@ export declare const translatable: {
     readonly help_darkHighlightTheme: "Specify the code highlighting theme in dark mode";
     readonly help_highlightLanguages: "Specify the languages which will be loaded to highlight code when rendering";
     readonly help_customCss: "Path to a custom CSS file to for the theme to import";
+    readonly help_customJs: "Path to a custom JS file to import";
     readonly help_markdownItOptions: "Specify the options passed to markdown-it, the Markdown parser used by TypeDoc";
     readonly help_markdownItLoader: "Specify a callback to be called when loading the markdown-it instance. Will be passed the instance of the parser which TypeDoc will use";
     readonly help_maxTypeConversionDepth: "Set the maximum depth of types to be converted";
@@ -159,6 +161,7 @@ export declare const translatable: {
     readonly help_readme: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page";
     readonly help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages";
     readonly help_sourceLinkExternal: "Specifies that source links should be treated as external links to be opened in a new tab";
+    readonly help_markdownLinkExternal: "Specifies that http[s]:// links in comments and markdown files should be treated as external links to be opened in a new tab";
     readonly help_githubPages: "Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to `true`";
     readonly help_hostedBaseUrl: "Specify a base URL to be used in generating a sitemap.xml in our output folder and canonical links. If not specified, no sitemap will be generated";
     readonly help_useHostedBaseUrlForAbsoluteLinks: "If set, TypeDoc will produce absolute links to pages on your site using the hostedBaseUrl option";

package/dist/lib/internationalization/translatable.js

@@ -88,6 +88,7 @@ exports.translatable = {
     git_remote_0_not_valid: `The provided git remote "{0}" was not valid. Source links will be broken`,
     // output plugins
     custom_css_file_0_does_not_exist: `Custom CSS file at {0} does not exist`,
+    custom_js_file_0_does_not_exist: `Custom JavaScript file at {0} does not exist`,
     unsupported_highlight_language_0_not_highlighted_in_comment_for_1: `Unsupported highlight language {0} will not be highlighted in comment for {1}`,
     unloaded_language_0_not_highlighted_in_comment_for_1: `Code block with language {0} will not be highlighted in comment for {1} as it was not included in the highlightLanguages option`,
     yaml_frontmatter_not_an_object: `Expected YAML frontmatter to be an object`,
@@ -162,6 +163,7 @@ exports.translatable = {
     help_darkHighlightTheme: "Specify the code highlighting theme in dark mode",
     help_highlightLanguages: "Specify the languages which will be loaded to highlight code when rendering",
     help_customCss: "Path to a custom CSS file to for the theme to import",
+    help_customJs: "Path to a custom JS file to import",
     help_markdownItOptions: "Specify the options passed to markdown-it, the Markdown parser used by TypeDoc",
     help_markdownItLoader: "Specify a callback to be called when loading the markdown-it instance. Will be passed the instance of the parser which TypeDoc will use",
     help_maxTypeConversionDepth: "Set the maximum depth of types to be converted",
@@ -177,6 +179,7 @@ exports.translatable = {
     help_readme: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page",
     help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages",
     help_sourceLinkExternal: "Specifies that source links should be treated as external links to be opened in a new tab",
+    help_markdownLinkExternal: "Specifies that http[s]:// links in comments and markdown files should be treated as external links to be opened in a new tab",
     help_githubPages: "Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to `true`",
     help_hostedBaseUrl: "Specify a base URL to be used in generating a sitemap.xml in our output folder and canonical links. If not specified, no sitemap will be generated",
     help_useHostedBaseUrlForAbsoluteLinks: "If set, TypeDoc will produce absolute links to pages on your site using the hostedBaseUrl option",

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

@@ -150,8 +150,10 @@ class DeclarationReflection extends container_1.ContainerReflection {
         this.type = de.revive(obj.type, (t) => de.constructType(t));
         this.signatures = de.reviveMany(obj.signatures, (r) => de.constructReflection(r));
         // TypeDoc 0.25, remove check with 0.28.
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         if (obj.indexSignature) {
             this.indexSignatures = [
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
                 de.revive(obj.indexSignature, (r) => de.constructReflection(r)),
             ];
         }

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

@@ -61,7 +61,9 @@ class SignatureReflection extends abstract_1.Reflection {
     fromObject(de, obj) {
         super.fromObject(de, obj);
         this.sources = de.reviveMany(obj.sources, (t) => new file_1.SourceReference(t.fileName, t.line, t.character));
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         if (obj.typeParameter) {
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             this.typeParameters = de.reviveMany(obj.typeParameter, (t) => de.constructReflection(t));
         }
         else {

package/dist/lib/output/events.d.ts

@@ -57,7 +57,7 @@ export interface PageHeading {
  * @see {@link Renderer.EVENT_BEGIN_PAGE}
  * @see {@link Renderer.EVENT_END_PAGE}
  */
-export declare class PageEvent<out Model = unknown> extends Event {
+export declare class PageEvent<out Model = unknown> {
     /**
      * The project the renderer is currently processing.
      */
@@ -107,6 +107,8 @@ export declare class PageEvent<out Model = unknown> extends Event {
      * @event
      */
     static readonly END = "endPage";
+    constructor(model: Model);
+    /** @deprecated use the single constructor arg instead, will be removed in 0.27 */
     constructor(name: string, model: Model);
 }
 /**

package/dist/lib/output/events.js

@@ -45,7 +45,7 @@ class RendererEvent {
      * @returns A newly created {@link PageEvent} instance.
      */
     createPageEvent(mapping) {
-        const event = new PageEvent(PageEvent.BEGIN, mapping.model);
+        const event = new PageEvent(mapping.model);
         event.project = this.project;
         event.url = mapping.url;
         event.filename = Path.join(this.outputDirectory, mapping.url);
@@ -70,7 +70,7 @@ RendererEvent.END = "endRender";
  * @see {@link Renderer.EVENT_BEGIN_PAGE}
  * @see {@link Renderer.EVENT_END_PAGE}
  */
-class PageEvent extends Event {
+class PageEvent {
     /**
      * Start a new section of the page. Sections are collapsible within
      * the "On This Page" sidebar.
@@ -82,8 +82,7 @@ class PageEvent extends Event {
             headings: this.pageHeadings,
         });
     }
-    constructor(name, model) {
-        super(name);
+    constructor(nameOrModel, model) {
         /**
          * Links to content within this page that should be rendered in the page navigation.
          * This is built when rendering the document content.
@@ -98,7 +97,12 @@ class PageEvent extends Event {
                 headings: this.pageHeadings,
             },
         ];
-        this.model = model;
+        if (typeof nameOrModel === "string") {
+            this.model = model;
+        }
+        else {
+            this.model = nameOrModel;
+        }
     }
 }
 exports.PageEvent = PageEvent;

package/dist/lib/output/plugins/AssetsPlugin.d.ts

@@ -4,8 +4,8 @@ import { RendererComponent } from "../components";
  * source folder to the output directory.
  */
 export declare class AssetsPlugin extends RendererComponent {
-    /** @internal */
-    accessor customCss: string;
+    private accessor customCss;
+    private accessor customJs;
     getTranslatedStrings(): {
         copy: import("../../internationalization").TranslatedString;
         copied: import("../../internationalization").TranslatedString;

package/dist/lib/output/plugins/AssetsPlugin.js

@@ -63,7 +63,7 @@ const path_1 = require("path");
  * source folder to the output directory.
  */
 let AssetsPlugin = (() => {
-    var _AssetsPlugin_customCss_accessor_storage;
+    var _AssetsPlugin_customCss_accessor_storage, _AssetsPlugin_customJs_accessor_storage;
     let _classDecorators = [(0, components_1.Component)({ name: "assets" })];
     let _classDescriptor;
     let _classExtraInitializers = [];
@@ -72,10 +72,14 @@ let AssetsPlugin = (() => {
     let _customCss_decorators;
     let _customCss_initializers = [];
     let _customCss_extraInitializers = [];
+    let _customJs_decorators;
+    let _customJs_initializers = [];
+    let _customJs_extraInitializers = [];
     var AssetsPlugin = _classThis = class extends _classSuper {
-        /** @internal */
         get customCss() { return __classPrivateFieldGet(this, _AssetsPlugin_customCss_accessor_storage, "f"); }
         set customCss(value) { __classPrivateFieldSet(this, _AssetsPlugin_customCss_accessor_storage, value, "f"); }
+        get customJs() { return __classPrivateFieldGet(this, _AssetsPlugin_customJs_accessor_storage, "f"); }
+        set customJs(value) { __classPrivateFieldSet(this, _AssetsPlugin_customJs_accessor_storage, value, "f"); }
         getTranslatedStrings() {
             return {
                 copy: this.application.i18n.theme_copy(),
@@ -100,6 +104,14 @@ let AssetsPlugin = (() => {
                     this.application.logger.error(this.application.i18n.custom_css_file_0_does_not_exist(this.customCss));
                 }
             }
+            if (this.customJs) {
+                if ((0, fs_2.existsSync)(this.customJs)) {
+                    (0, fs_1.copySync)(this.customJs, (0, path_1.join)(dest, "custom.js"));
+                }
+                else {
+                    this.application.logger.error(this.application.i18n.custom_js_file_0_does_not_exist(this.customJs));
+                }
+            }
         }
         /**
          * Triggered before the renderer starts rendering a project.
@@ -128,15 +140,19 @@ let AssetsPlugin = (() => {
         constructor() {
             super(...arguments);
             _AssetsPlugin_customCss_accessor_storage.set(this, __runInitializers(this, _customCss_initializers, void 0));
-            __runInitializers(this, _customCss_extraInitializers);
+            _AssetsPlugin_customJs_accessor_storage.set(this, (__runInitializers(this, _customCss_extraInitializers), __runInitializers(this, _customJs_initializers, void 0)));
+            __runInitializers(this, _customJs_extraInitializers);
         }
     };
     _AssetsPlugin_customCss_accessor_storage = new WeakMap();
+    _AssetsPlugin_customJs_accessor_storage = new WeakMap();
     __setFunctionName(_classThis, "AssetsPlugin");
     (() => {
         const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
         _customCss_decorators = [(0, utils_1.Option)("customCss")];
+        _customJs_decorators = [(0, utils_1.Option)("customJs")];
         __esDecorate(_classThis, null, _customCss_decorators, { kind: "accessor", name: "customCss", static: false, private: false, access: { has: obj => "customCss" in obj, get: obj => obj.customCss, set: (obj, value) => { obj.customCss = value; } }, metadata: _metadata }, _customCss_initializers, _customCss_extraInitializers);
+        __esDecorate(_classThis, null, _customJs_decorators, { kind: "accessor", name: "customJs", static: false, private: false, access: { has: obj => "customJs" in obj, get: obj => obj.customJs, set: (obj, value) => { obj.customJs = value; } }, metadata: _metadata }, _customJs_initializers, _customJs_extraInitializers);
         __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
         AssetsPlugin = _classThis = _classDescriptor.value;
         if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });

package/dist/lib/output/renderer.d.ts

@@ -100,13 +100,11 @@ export interface RendererEvents {
  *
  *    * {@link Renderer.EVENT_BEGIN_PAGE}<br>
  *      Triggered before a document will be rendered. The listener receives an instance of
- *      {@link PageEvent}. By calling {@link PageEvent.preventDefault} the generation of the
- *      document can be canceled.
+ *      {@link PageEvent}.
  *
  *    * {@link Renderer.EVENT_END_PAGE}<br>
  *      Triggered after a document has been rendered, just before it is written to disc. The
- *      listener receives an instance of {@link PageEvent}. When calling
- *      {@link PageEvent.preventDefault} the the document will not be saved to disc.
+ *      listener receives an instance of {@link PageEvent}.
  *
  *  * {@link Renderer.EVENT_END}<br>
  *    Triggered after the renderer has written all documents. The listener receives

package/dist/lib/output/renderer.js

@@ -108,13 +108,11 @@ const jsx_1 = require("../utils/jsx");
  *
  *    * {@link Renderer.EVENT_BEGIN_PAGE}<br>
  *      Triggered before a document will be rendered. The listener receives an instance of
- *      {@link PageEvent}. By calling {@link PageEvent.preventDefault} the generation of the
- *      document can be canceled.
+ *      {@link PageEvent}.
  *
  *    * {@link Renderer.EVENT_END_PAGE}<br>
  *      Triggered after a document has been rendered, just before it is written to disc. The
- *      listener receives an instance of {@link PageEvent}. When calling
- *      {@link PageEvent.preventDefault} the the document will not be saved to disc.
+ *      listener receives an instance of {@link PageEvent}.
  *
  *  * {@link Renderer.EVENT_END}<br>
  *    Triggered after the renderer has written all documents. The listener receives

package/dist/lib/output/themes/MarkedPlugin.d.ts

@@ -11,6 +11,7 @@ export declare class MarkedPlugin extends ContextAwareRendererComponent {
     accessor lightTheme: BundledTheme;
     accessor darkTheme: BundledTheme;
     accessor markdownItOptions: Record<string, unknown>;
+    accessor markdownLinkExternal: boolean;
     private parser?;
     /**
      * This needing to be here really feels hacky... probably some nicer way to do this.

package/dist/lib/output/themes/MarkedPlugin.js

@@ -75,7 +75,7 @@ function getDefaultSlugger(logger) {
  * @internal
  */
 let MarkedPlugin = (() => {
-    var _MarkedPlugin_lightTheme_accessor_storage, _MarkedPlugin_darkTheme_accessor_storage, _MarkedPlugin_markdownItOptions_accessor_storage;
+    var _MarkedPlugin_lightTheme_accessor_storage, _MarkedPlugin_darkTheme_accessor_storage, _MarkedPlugin_markdownItOptions_accessor_storage, _MarkedPlugin_markdownLinkExternal_accessor_storage;
     let _classDecorators = [(0, components_1.Component)({ name: "marked" })];
     let _classDescriptor;
     let _classExtraInitializers = [];
@@ -90,13 +90,17 @@ let MarkedPlugin = (() => {
     let _markdownItOptions_decorators;
     let _markdownItOptions_initializers = [];
     let _markdownItOptions_extraInitializers = [];
+    let _markdownLinkExternal_decorators;
+    let _markdownLinkExternal_initializers = [];
+    let _markdownLinkExternal_extraInitializers = [];
     var MarkedPlugin = _classThis = class extends _classSuper {
         constructor() {
             super(...arguments);
             _MarkedPlugin_lightTheme_accessor_storage.set(this, __runInitializers(this, _lightTheme_initializers, void 0));
             _MarkedPlugin_darkTheme_accessor_storage.set(this, (__runInitializers(this, _lightTheme_extraInitializers), __runInitializers(this, _darkTheme_initializers, void 0)));
             _MarkedPlugin_markdownItOptions_accessor_storage.set(this, (__runInitializers(this, _darkTheme_extraInitializers), __runInitializers(this, _markdownItOptions_initializers, void 0)));
-            this.parser = __runInitializers(this, _markdownItOptions_extraInitializers);
+            _MarkedPlugin_markdownLinkExternal_accessor_storage.set(this, (__runInitializers(this, _markdownItOptions_extraInitializers), __runInitializers(this, _markdownLinkExternal_initializers, void 0)));
+            this.parser = __runInitializers(this, _markdownLinkExternal_extraInitializers);
             /**
              * This needing to be here really feels hacky... probably some nicer way to do this.
              * Revisit when adding support for arbitrary pages in 0.26.
@@ -110,6 +114,8 @@ let MarkedPlugin = (() => {
         set darkTheme(value) { __classPrivateFieldSet(this, _MarkedPlugin_darkTheme_accessor_storage, value, "f"); }
         get markdownItOptions() { return __classPrivateFieldGet(this, _MarkedPlugin_markdownItOptions_accessor_storage, "f"); }
         set markdownItOptions(value) { __classPrivateFieldSet(this, _MarkedPlugin_markdownItOptions_accessor_storage, value, "f"); }
+        get markdownLinkExternal() { return __classPrivateFieldGet(this, _MarkedPlugin_markdownLinkExternal_accessor_storage, "f"); }
+        set markdownLinkExternal(value) { __classPrivateFieldSet(this, _MarkedPlugin_markdownLinkExternal_accessor_storage, value, "f"); }
         /**
          * Create a new MarkedPlugin instance.
          */
@@ -290,6 +296,16 @@ let MarkedPlugin = (() => {
                 const token = tokens[idx];
                 const href = token.attrGet("href")?.replace(/^#(?:md:)?(.+)/, "#md:$1");
                 if (href) {
+                    // Note: This doesn't catch @link tags to reflections as those
+                    // will be relative links. This will likely have to change with
+                    // the introduction of support for customized routers whenever
+                    // that becomes a real thing.
+                    if (this.markdownLinkExternal && /https?:\/\//i.test(href)) {
+                        token.attrSet("target", "_blank");
+                        const classes = token.attrGet("class")?.split(" ") || [];
+                        classes.push("external");
+                        token.attrSet("class", classes.join(" "));
+                    }
                     token.attrSet("href", href);
                 }
                 return self.renderToken(tokens, idx, options);
@@ -307,15 +323,18 @@ let MarkedPlugin = (() => {
     _MarkedPlugin_lightTheme_accessor_storage = new WeakMap();
     _MarkedPlugin_darkTheme_accessor_storage = new WeakMap();
     _MarkedPlugin_markdownItOptions_accessor_storage = new WeakMap();
+    _MarkedPlugin_markdownLinkExternal_accessor_storage = new WeakMap();
     __setFunctionName(_classThis, "MarkedPlugin");
     (() => {
         const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
         _lightTheme_decorators = [(0, utils_1.Option)("lightHighlightTheme")];
         _darkTheme_decorators = [(0, utils_1.Option)("darkHighlightTheme")];
         _markdownItOptions_decorators = [(0, utils_1.Option)("markdownItOptions")];
+        _markdownLinkExternal_decorators = [(0, utils_1.Option)("markdownLinkExternal")];
         __esDecorate(_classThis, null, _lightTheme_decorators, { kind: "accessor", name: "lightTheme", static: false, private: false, access: { has: obj => "lightTheme" in obj, get: obj => obj.lightTheme, set: (obj, value) => { obj.lightTheme = value; } }, metadata: _metadata }, _lightTheme_initializers, _lightTheme_extraInitializers);
         __esDecorate(_classThis, null, _darkTheme_decorators, { kind: "accessor", name: "darkTheme", static: false, private: false, access: { has: obj => "darkTheme" in obj, get: obj => obj.darkTheme, set: (obj, value) => { obj.darkTheme = value; } }, metadata: _metadata }, _darkTheme_initializers, _darkTheme_extraInitializers);
         __esDecorate(_classThis, null, _markdownItOptions_decorators, { kind: "accessor", name: "markdownItOptions", static: false, private: false, access: { has: obj => "markdownItOptions" in obj, get: obj => obj.markdownItOptions, set: (obj, value) => { obj.markdownItOptions = value; } }, metadata: _metadata }, _markdownItOptions_initializers, _markdownItOptions_extraInitializers);
+        __esDecorate(_classThis, null, _markdownLinkExternal_decorators, { kind: "accessor", name: "markdownLinkExternal", static: false, private: false, access: { has: obj => "markdownLinkExternal" in obj, get: obj => obj.markdownLinkExternal, set: (obj, value) => { obj.markdownLinkExternal = value; } }, metadata: _metadata }, _markdownLinkExternal_initializers, _markdownLinkExternal_extraInitializers);
         __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
         MarkedPlugin = _classThis = _classDescriptor.value;
         if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });

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

@@ -258,6 +258,9 @@ class DefaultTheme extends theme_1.Theme {
                     children,
                 };
             }
+            if (opts.excludeReferences && element instanceof models_1.ReferenceReflection) {
+                return;
+            }
             return {
                 text: (0, lib_1.getDisplayName)(element),
                 path: element.url,

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

@@ -17,6 +17,7 @@ const defaultLayout = (context, template, props) => (utils_1.JSX.createElement("
         utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/highlight.css", true) }),
         context.options.getValue("customCss") && (utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/custom.css", true) })),
         utils_1.JSX.createElement("script", { defer: true, src: context.relativeURL("assets/main.js", true) }),
+        context.options.getValue("customJs") && (utils_1.JSX.createElement("script", { defer: true, src: context.relativeURL("assets/custom.js", true) })),
         utils_1.JSX.createElement("script", { async: true, src: context.relativeURL("assets/icons.js", true), id: "tsd-icons-script" }),
         utils_1.JSX.createElement("script", { async: true, src: context.relativeURL("assets/search.js", true), id: "tsd-search-script" }),
         utils_1.JSX.createElement("script", { async: true, src: context.relativeURL("assets/navigation.js", true), id: "tsd-nav-script" }),

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

@@ -85,6 +85,7 @@ export interface TypeDocOptionMap {
     disableSources: boolean;
     sourceLinkTemplate: string;
     sourceLinkExternal: boolean;
+    markdownLinkExternal: boolean;
     disableGit: boolean;
     gitRevision: string;
     gitRemote: string;
@@ -98,6 +99,7 @@ export interface TypeDocOptionMap {
     darkHighlightTheme: ShikiTheme;
     highlightLanguages: string[];
     customCss: string;
+    customJs: string;
     markdownItOptions: ManuallyValidatedOption<Record<string, unknown>>;
     /**
      * Will be called when TypeDoc is setting up the markdown parser to use to render markdown.
@@ -142,6 +144,7 @@ export interface TypeDocOptionMap {
         includeGroups: boolean;
         includeFolders: boolean;
         compactFolders: boolean;
+        excludeReferences: boolean;
     };
     visibilityFilters: ManuallyValidatedOption<{
         protected?: boolean;

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

@@ -298,6 +298,11 @@ function addTypeDocOptions(options) {
         help: (i18n) => i18n.help_customCss(),
         type: declaration_1.ParameterType.Path,
     });
+    options.addDeclaration({
+        name: "customJs",
+        help: (i18n) => i18n.help_customJs(),
+        type: declaration_1.ParameterType.Path,
+    });
     options.addDeclaration({
         name: "markdownItOptions",
         help: (i18n) => i18n.help_markdownItOptions(),
@@ -393,6 +398,12 @@ function addTypeDocOptions(options) {
         help: (i18n) => i18n.help_sourceLinkExternal(),
         type: declaration_1.ParameterType.Boolean,
     });
+    options.addDeclaration({
+        name: "markdownLinkExternal",
+        help: (i18n) => i18n.help_markdownLinkExternal(),
+        type: declaration_1.ParameterType.Boolean,
+        defaultValue: true,
+    });
     options.addDeclaration({
         name: "githubPages",
         help: (i18n) => i18n.help_githubPages(),
@@ -403,7 +414,7 @@ function addTypeDocOptions(options) {
         name: "hostedBaseUrl",
         help: (i18n) => i18n.help_hostedBaseUrl(),
         validate(value, i18n) {
-            if (!/https?:\/\//.test(value)) {
+            if (!/https?:\/\//i.test(value)) {
                 throw new Error(i18n.hostedBaseUrl_must_start_with_http());
             }
         },
@@ -502,6 +513,7 @@ function addTypeDocOptions(options) {
             includeGroups: false,
             includeFolders: true,
             compactFolders: true,
+            excludeReferences: false,
         },
     });
     options.addDeclaration({

package/dist/lib/utils/options/tsdoc-defaults.d.ts

@@ -3,4 +3,4 @@ export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@exam
 export declare const tsdocInlineTags: readonly ["@link", "@inheritDoc", "@label"];
 export declare const inlineTags: readonly ["@link", "@inheritDoc", "@label", "@linkcode", "@linkplain"];
 export declare const tsdocModifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual"];
-export declare const modifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual", "@class", "@enum", "@event", "@hidden", "@hideCategories", "@hideconstructor", "@hideGroups", "@ignore", "@interface", "@namespace", "@overload", "@private", "@protected", "@showCategories", "@showGroups"];
+export declare const modifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual", "@abstract", "@class", "@enum", "@event", "@hidden", "@hideCategories", "@hideconstructor", "@hideGroups", "@ignore", "@interface", "@namespace", "@overload", "@private", "@protected", "@showCategories", "@showGroups"];

package/dist/lib/utils/options/tsdoc-defaults.js

@@ -62,6 +62,7 @@ exports.tsdocModifierTags = [
 ];
 exports.modifierTags = [
     ...exports.tsdocModifierTags,
+    "@abstract",
     "@class",
     "@enum",
     "@event",

package/dist/lib/utils/sort.js

@@ -46,14 +46,14 @@ const sorts = {
         return false;
     },
     alphabetical(a, b) {
-        return a.name < b.name;
+        return a.name.localeCompare(b.name) < 0;
     },
     "alphabetical-ignoring-documents"(a, b) {
         if (a.kindOf(kind_1.ReflectionKind.Document) ||
             b.kindOf(kind_1.ReflectionKind.Document)) {
             return false;
         }
-        return a.name < b.name;
+        return a.name.localeCompare(b.name) < 0;
     },
     "enum-value-ascending"(a, b) {
         if (a.kind == kind_1.ReflectionKind.EnumMember &&

package/dist/lib/validation/links.js

@@ -8,7 +8,7 @@ function getBrokenPartLinks(parts) {
     for (const part of parts) {
         if (part.kind === "inline-tag" &&
             linkTags.includes(part.tag) &&
-            !part.target) {
+            (!part.target || part.target instanceof models_1.ReflectionSymbolId)) {
             links.push(part.text.trim());
         }
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.26.6",
+  "version": "0.26.7",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -27,27 +27,27 @@
     "lunr": "^2.3.9",
     "markdown-it": "^14.1.0",
     "minimatch": "^9.0.5",
-    "shiki": "^1.9.1",
-    "yaml": "^2.4.5"
+    "shiki": "^1.16.2",
+    "yaml": "^2.5.1"
   },
   "peerDependencies": {
-    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x"
+    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x"
   },
   "devDependencies": {
     "@types/lunr": "^2.3.7",
-    "@types/markdown-it": "^14.1.1",
+    "@types/markdown-it": "^14.1.2",
     "@types/mocha": "^10.0.7",
     "@types/node": "18",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#34113409e3a171e68ce5e2b55461ef5c35591cfe",
     "c8": "^10.1.2",
-    "esbuild": "^0.21.5",
-    "eslint": "^9.5.0",
-    "mocha": "^10.5.2",
-    "prettier": "3.3.2",
-    "puppeteer": "^22.12.1",
+    "esbuild": "^0.23.1",
+    "eslint": "^9.9.1",
+    "mocha": "^10.7.3",
+    "prettier": "3.3.3",
+    "puppeteer": "^23.3.0",
     "ts-node": "^10.9.2",
-    "typescript": "5.5.2",
-    "typescript-eslint": "^8.0.1"
+    "typescript": "5.6.1-rc",
+    "typescript-eslint": "^8.4.0"
   },
   "files": [
     "/bin",

package/tsdoc.json

@@ -67,6 +67,10 @@
             "tagName": "@class",
             "syntaxKind": "modifier"
         },
+        {
+            "tagName": "@abstract",
+            "syntaxKind": "modifier"
+        },
         {
             "tagName": "@document",
             "syntaxKind": "block"