typedoc 0.26.9 → 0.26.11

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

@@ -1,4 +1,27 @@
 "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 };
 };
@@ -12,7 +35,7 @@ const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 const declaration_1 = require("../../utils/options/declaration");
 const paths_1 = require("../../utils/paths");
-const assert_1 = require("assert");
+const assert_1 = __importStar(require("assert"));
 const array_1 = require("../../utils/array");
 const variablePropertyKinds = [
     typescript_1.default.SyntaxKind.PropertyDeclaration,
@@ -375,11 +398,30 @@ function declarationToCommentNodes(node, checker) {
             inheritedFromParentDeclaration: false,
         },
     ];
+    let overloadIndex = undefined;
+    if (typescript_1.default.isMethodDeclaration(node)) {
+        const symbol = checker.getSymbolAtLocation(node.name || node);
+        if (symbol) {
+            overloadIndex = symbol.declarations
+                ?.filter((d) => d.kind === node.kind)
+                .indexOf(node);
+            (0, assert_1.default)(overloadIndex !== -1, "Should always find declaration");
+        }
+    }
     const seenSymbols = new Set();
     const bases = findBaseOfDeclaration(checker, node, (symbol) => {
         if (!seenSymbols.has(symbol)) {
             seenSymbols.add(symbol);
-            return symbol.declarations?.map((node) => declarationToCommentNodeIgnoringParents(node) || node);
+            if (overloadIndex === undefined) {
+                return symbol.declarations?.map((node) => declarationToCommentNodeIgnoringParents(node) || node);
+            }
+            else if (symbol.declarations?.[overloadIndex]) {
+                const parentSigNode = symbol.declarations[overloadIndex];
+                return [
+                    declarationToCommentNodeIgnoringParents(parentSigNode) ||
+                        parentSigNode,
+                ];
+            }
         }
     });
     for (const parentCommentNode of bases || []) {

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

@@ -3,6 +3,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultLayout = void 0;
 const utils_1 = require("../../../../utils");
 const lib_1 = require("../../lib");
+// See #2760
+function buildSiteMetadata(context) {
+    try {
+        // We have to know where we are hosted in order to generate this block
+        const url = new URL(context.options.getValue("hostedBaseUrl"));
+        // No point in generating this if we aren't the root page on the site
+        if (url.pathname !== "/") {
+            return null;
+        }
+        return (utils_1.JSX.createElement("script", { type: "application/ld+json" },
+            utils_1.JSX.createElement(utils_1.Raw, { html: JSON.stringify({
+                    "@context": "https://schema.org",
+                    "@type": "WebSite",
+                    name: context.page.project.name,
+                    url: url.toString(),
+                }) })));
+    }
+    catch {
+        return null;
+    }
+}
 const defaultLayout = (context, template, props) => (utils_1.JSX.createElement("html", { class: "default", lang: context.options.getValue("lang") },
     utils_1.JSX.createElement("head", null,
         utils_1.JSX.createElement("meta", { charset: "utf-8" }),
@@ -11,6 +32,7 @@ const defaultLayout = (context, template, props) => (utils_1.JSX.createElement("
         utils_1.JSX.createElement("title", null, props.model.isProject()
             ? (0, lib_1.getDisplayName)(props.model)
             : `${(0, lib_1.getDisplayName)(props.model)} | ${(0, lib_1.getDisplayName)(props.project)}`),
+        props.url === "index.html" && buildSiteMetadata(context),
         utils_1.JSX.createElement("meta", { name: "description", content: "Documentation for " + props.project.name }),
         utils_1.JSX.createElement("meta", { name: "viewport", content: "width=device-width, initial-scale=1" }),
         utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/style.css", true) }),

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

@@ -26,7 +26,7 @@ const header = (context, props) => {
     }
     else {
         renderTitle = true;
-        titleKindString = " " + context.internationalization.kindSingularString(props.model.kind);
+        titleKindString = context.internationalization.kindSingularString(props.model.kind) + " ";
     }
     return (utils_1.JSX.createElement("div", { class: "tsd-page-title" },
         renderBreadcrumbs && utils_1.JSX.createElement("ul", { class: "tsd-breadcrumb" }, context.breadcrumb(props.model)),

package/dist/lib/utils/map.d.ts

@@ -6,7 +6,7 @@ export declare class DefaultMap<K, V> extends Map<K, V> {
 }
 export declare class StableKeyMap<K extends {
     getStableKey(): string;
-}, V> implements Map<K, V> {
+}, V> {
     [Symbol.toStringTag]: string;
     private impl;
     get size(): number;

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

@@ -90,21 +90,10 @@ class TypeDocReader {
         }
         else {
             try {
-                try {
-                    // eslint-disable-next-line @typescript-eslint/no-require-imports
-                    fileContent = await require(file);
-                }
-                catch (error) {
-                    if (error?.code === "ERR_REQUIRE_ESM") {
-                        // On Windows, we need to ensure this path is a file path.
-                        // Or we'll get ERR_UNSUPPORTED_ESM_URL_SCHEME
-                        const esmPath = (0, url_1.pathToFileURL)(file).toString();
-                        fileContent = await (await import(esmPath)).default;
-                    }
-                    else {
-                        throw error;
-                    }
-                }
+                // On Windows, we need to ensure this path is a file path.
+                // Or we'll get ERR_UNSUPPORTED_ESM_URL_SCHEME
+                const esmPath = (0, url_1.pathToFileURL)(file).toString();
+                fileContent = await (await import(esmPath)).default;
             }
             catch (error) {
                 logger.error(logger.i18n.failed_read_options_file_0((0, paths_1.nicePath)(file)));

package/dist/lib/utils/plugins.js

@@ -9,18 +9,20 @@ async function loadPlugins(app, plugins) {
         const pluginDisplay = getPluginDisplayName(plugin);
         try {
             let instance;
+            // Try importing first to avoid warnings about requiring ESM being experimental.
+            // If that fails due to importing a directory, fall back to require.
             try {
-                // eslint-disable-next-line @typescript-eslint/no-require-imports
-                instance = require(plugin);
+                // On Windows, we need to ensure this path is a file path.
+                // Or we'll get ERR_UNSUPPORTED_ESM_URL_SCHEME
+                const esmPath = (0, path_1.isAbsolute)(plugin)
+                    ? (0, url_1.pathToFileURL)(plugin).toString()
+                    : plugin;
+                instance = await import(esmPath);
             }
             catch (error) {
-                if (error.code === "ERR_REQUIRE_ESM") {
-                    // On Windows, we need to ensure this path is a file path.
-                    // Or we'll get ERR_UNSUPPORTED_ESM_URL_SCHEME
-                    const esmPath = (0, path_1.isAbsolute)(plugin)
-                        ? (0, url_1.pathToFileURL)(plugin).toString()
-                        : plugin;
-                    instance = await import(esmPath);
+                if (error.code === "ERR_UNSUPPORTED_DIR_IMPORT") {
+                    // eslint-disable-next-line @typescript-eslint/no-require-imports
+                    instance = require(plugin);
                 }
                 else {
                     throw error;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.26.9",
+  "version": "0.26.11",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -46,7 +46,7 @@
     "prettier": "3.3.3",
     "puppeteer": "^23.3.0",
     "ts-node": "^10.9.2",
-    "typescript": "5.6.1-rc",
+    "typescript": "5.6.3",
     "typescript-eslint": "^8.4.0"
   },
   "files": [