typedoc 0.24.0-beta.7 → 0.24.0-beta.8

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

@@ -1,17 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.secondaryNavigation = exports.primaryNavigation = exports.settings = exports.sidebarLinks = exports.navigation = void 0;
+exports.pageNavigation = exports.pageSidebar = exports.navigation = exports.settings = exports.sidebarLinks = exports.sidebar = void 0;
 const models_1 = require("../../../../models");
 const utils_1 = require("../../../../utils");
 const lib_1 = require("../../lib");
-function navigation(context, props) {
+function sidebar(context, props) {
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
         context.sidebarLinks(),
-        context.settings(),
-        context.primaryNavigation(props),
-        context.secondaryNavigation(props)));
+        context.navigation(props)));
 }
-exports.navigation = navigation;
+exports.sidebar = sidebar;
 function buildFilterItem(context, name, displayName, defaultValue) {
     return (utils_1.JSX.createElement("li", { class: "tsd-filter-item" },
         utils_1.JSX.createElement("label", { class: "tsd-filter-input" },
@@ -50,7 +48,7 @@ function settings(context) {
             utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary" },
                 utils_1.JSX.createElement("h3", null,
                     context.icons.chevronDown(),
-                    " Settings")),
+                    "Settings")),
             utils_1.JSX.createElement("div", { class: "tsd-accordion-details" },
                 visibilityOptions.length && (utils_1.JSX.createElement("div", { class: "tsd-filter-visibility" },
                     utils_1.JSX.createElement("h4", { class: "uppercase" }, "Member Visibility"),
@@ -64,79 +62,78 @@ function settings(context) {
                         utils_1.JSX.createElement("option", { value: "dark" }, "Dark")))))));
 }
 exports.settings = settings;
-function primaryNavigation(context, props) {
+function navigation(context, props) {
     // Create the navigation for the current page
-    const modules = props.model.project.getChildrenByKind(models_1.ReflectionKind.SomeModule);
-    const [ext, int] = (0, utils_1.partition)(modules, (m) => m.flags.isExternal);
-    const selected = props.model.isProject();
-    const current = selected || int.some((mod) => inPath(mod, props.model));
-    return (utils_1.JSX.createElement("nav", { class: "tsd-navigation primary" },
-        utils_1.JSX.createElement("details", { class: "tsd-index-accordion", open: true },
+    // Recurse to children if the parent is some kind of module
+    return (utils_1.JSX.createElement("nav", { class: "tsd-navigation" },
+        link(props.project),
+        utils_1.JSX.createElement("ul", { class: "tsd-small-nested-navigation" }, props.project.children?.map((c) => (utils_1.JSX.createElement("li", null, links(c)))))));
+    function links(mod) {
+        const children = (mod.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project) && mod.children) || [];
+        const nameClasses = (0, lib_1.classNames)({ deprecated: mod.isDeprecated() }, mod.isProject() ? void 0 : context.getReflectionClasses(mod));
+        if (!children.length) {
+            return link(mod, nameClasses);
+        }
+        return (utils_1.JSX.createElement("details", { class: (0, lib_1.classNames)({ "tsd-index-accordion": true }, nameClasses), open: inPath(mod), "data-key": mod.getFullName() },
             utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary" },
-                utils_1.JSX.createElement("h3", null,
-                    context.icons.chevronDown(),
-                    " Modules")),
+                context.icons.chevronDown(),
+                link(mod)),
             utils_1.JSX.createElement("div", { class: "tsd-accordion-details" },
-                utils_1.JSX.createElement("ul", null,
-                    utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ current, selected }) },
-                        utils_1.JSX.createElement("a", { href: context.urlTo(props.model.project) }, (0, lib_1.wbr)(props.project.name)),
-                        utils_1.JSX.createElement("ul", null, int.map(link))),
-                    ext.map(link))))));
-    function link(mod) {
-        const current = inPath(mod, props.model);
-        const selected = mod.name === props.model.name;
-        let childNav;
-        const childModules = mod.children?.filter((m) => m.kindOf(models_1.ReflectionKind.SomeModule));
-        if (childModules?.length) {
-            childNav = utils_1.JSX.createElement("ul", null, childModules.map(link));
-        }
-        return (utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ current, selected, deprecated: mod.isDeprecated() }, context.getReflectionClasses(mod)) },
-            utils_1.JSX.createElement("a", { href: context.urlTo(mod) }, (0, lib_1.wbr)((0, lib_1.getDisplayName)(mod))),
-            childNav));
+                utils_1.JSX.createElement("ul", { class: "tsd-nested-navigation" }, children.map((c) => (utils_1.JSX.createElement("li", null, links(c))))))));
     }
-}
-exports.primaryNavigation = primaryNavigation;
-function secondaryNavigation(context, props) {
-    // Multiple entry points, and on main project page.
-    if (props.model.isProject() && props.model.getChildrenByKind(models_1.ReflectionKind.Module).length) {
-        return;
+    function link(child, nameClasses) {
+        return (utils_1.JSX.createElement("a", { href: context.urlTo(child), class: (0, lib_1.classNames)({ current: child === props.model }, nameClasses) },
+            context.icons[child.kind](),
+            utils_1.JSX.createElement("span", null, (0, lib_1.wbr)((0, lib_1.getDisplayName)(child)))));
     }
-    const effectivePageParent = (props.model instanceof models_1.ContainerReflection && props.model.children?.length) || props.model.isProject()
-        ? props.model
-        : props.model.parent;
-    const children = effectivePageParent.children || [];
-    const pageNavigation = children
-        .filter((child) => !child.kindOf(models_1.ReflectionKind.SomeModule))
-        .map((child) => {
-        return (utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ deprecated: child.isDeprecated(), current: props.model === child }, context.getReflectionClasses(child)) },
-            utils_1.JSX.createElement("a", { href: context.urlTo(child), class: "tsd-index-link" },
-                context.icons[child.kind](),
-                utils_1.JSX.createElement("span", null, (0, lib_1.renderName)(child)))));
-    });
-    if (effectivePageParent.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
-        return (utils_1.JSX.createElement("nav", { class: "tsd-navigation secondary menu-sticky" }, !!pageNavigation.length && utils_1.JSX.createElement("ul", null, pageNavigation)));
+    function inPath(mod) {
+        let iter = props.model;
+        do {
+            if (iter == mod)
+                return true;
+            iter = iter.parent;
+        } while (iter);
+        return false;
     }
-    return (utils_1.JSX.createElement("nav", { class: "tsd-navigation secondary menu-sticky" },
-        utils_1.JSX.createElement("ul", null,
-            utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({
-                    deprecated: effectivePageParent.isDeprecated(),
-                    current: effectivePageParent === props.model,
-                }, effectivePageParent instanceof models_1.DeclarationReflection
-                    ? context.getReflectionClasses(effectivePageParent)
-                    : "") },
-                utils_1.JSX.createElement("a", { href: context.urlTo(effectivePageParent), class: "tsd-index-link" },
-                    context.icons[effectivePageParent.kind](),
-                    utils_1.JSX.createElement("span", null, (0, lib_1.renderName)(effectivePageParent))),
-                !!pageNavigation.length && utils_1.JSX.createElement("ul", null, pageNavigation)))));
 }
-exports.secondaryNavigation = secondaryNavigation;
-function inPath(thisPage, toCheck) {
-    while (toCheck) {
-        if (toCheck.isProject())
-            return false;
-        if (thisPage === toCheck)
-            return true;
-        toCheck = toCheck.parent;
+exports.navigation = navigation;
+function pageSidebar(context, props) {
+    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+        context.settings(),
+        context.pageNavigation(props)));
+}
+exports.pageSidebar = pageSidebar;
+function pageNavigation(context, props) {
+    const levels = [[]];
+    function finalizeLevel() {
+        const built = (utils_1.JSX.createElement("ul", null, levels.pop().map((l) => (utils_1.JSX.createElement("li", null, l)))));
+        levels[levels.length - 1].push(built);
+    }
+    for (const heading of props.pageHeadings) {
+        const inferredLevel = heading.level ? heading.level + 1 : 1;
+        while (inferredLevel < levels.length) {
+            finalizeLevel();
+        }
+        if (inferredLevel > levels.length) {
+            // Lower level than before
+            levels.push([]);
+        }
+        levels[levels.length - 1].push(utils_1.JSX.createElement("a", { href: heading.link, class: heading.classes },
+            heading.kind && context.icons[heading.kind](),
+            utils_1.JSX.createElement("span", null, (0, lib_1.wbr)(heading.text))));
+    }
+    while (levels.length > 1) {
+        finalizeLevel();
+    }
+    if (!levels[0].length) {
+        return utils_1.JSX.createElement(utils_1.JSX.Fragment, null);
     }
-    return false;
+    return (utils_1.JSX.createElement("details", { open: true, class: "tsd-index-accordion tsd-page-navigation" },
+        utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary" },
+            utils_1.JSX.createElement("h3", null,
+                context.icons.chevronDown(),
+                "On This Page")),
+        utils_1.JSX.createElement("div", { class: "tsd-accordion-details" },
+            utils_1.JSX.createElement("ul", null, levels[0].map((l) => (utils_1.JSX.createElement("li", null, l)))))));
 }
+exports.pageNavigation = pageNavigation;

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toolbar = void 0;
 const utils_1 = require("../../../../utils");
+const lib_1 = require("../../lib");
 const toolbar = (context, props) => (utils_1.JSX.createElement("header", { class: "tsd-page-toolbar" },
     utils_1.JSX.createElement("div", { class: "tsd-toolbar-contents container" },
         utils_1.JSX.createElement("div", { class: "table-cell", id: "tsd-search", "data-base": context.relativeURL("./") },
@@ -13,7 +14,7 @@ const toolbar = (context, props) => (utils_1.JSX.createElement("header", { class
             utils_1.JSX.createElement("ul", { class: "results" },
                 utils_1.JSX.createElement("li", { class: "state loading" }, "Preparing search index..."),
                 utils_1.JSX.createElement("li", { class: "state failure" }, "The search index is not available")),
-            utils_1.JSX.createElement("a", { href: context.options.getValue("titleLink") || context.relativeURL("index.html"), class: "title" }, props.project.name)),
+            utils_1.JSX.createElement("a", { href: context.options.getValue("titleLink") || context.relativeURL("index.html"), class: "title" }, (0, lib_1.getDisplayName)(props.project))),
         utils_1.JSX.createElement("div", { class: "table-cell", id: "tsd-widgets" },
             utils_1.JSX.createElement("a", { href: "#", class: "tsd-widget tsd-toolbar-icon menu no-caption", "data-toggle": "menu", "aria-label": "Menu" }, context.icons.menu())))));
 exports.toolbar = toolbar;

package/dist/lib/serialization/schema.d.ts

@@ -26,6 +26,7 @@
  *
  * For documentation on the JSON output properties, view the corresponding model.
  * @module
+ * @internal
  */
 import type * as M from "../models";
 /**

package/dist/lib/serialization/schema.js

@@ -27,5 +27,6 @@
  *
  * For documentation on the JSON output properties, view the corresponding model.
  * @module
+ * @internal
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/serialization/serializer.d.ts

@@ -15,7 +15,7 @@ export declare class Serializer extends EventDispatcher {
     static EVENT_END: string;
     private serializers;
     /**
-     * Only set after resolve.
+     * Only set when serializing.
      */
     projectRoot: string;
     addSerializer(serializer: SerializerComponent<any>): void;

package/dist/lib/utils/entry-point.d.ts

@@ -7,7 +7,7 @@ import type { Options } from "./options";
  */
 export declare const EntryPointStrategy: {
     /**
-     * The default behavior in v0.22-v0.23, expects all provided entry points as being part of a single program.
+     * The default behavior in v0.22+, expects all provided entry points as being part of a single program.
      * Any directories included in the entry point list will result in `dir/index.([cm][tj]s|[tj]sx?)` being used.
      */
     readonly Resolve: "resolve";
@@ -17,8 +17,8 @@ export declare const EntryPointStrategy: {
      */
     readonly Expand: "expand";
     /**
-     * Run TypeDoc in each directory passed as an entry point, and save the json result to `.typedoc/<project>`
-     * Once all have been saved, use the merge option to produce final output.
+     * Run TypeDoc in each directory passed as an entry point. Once all directories have been converted,
+     * use the merge option to produce final output.
      */
     readonly Packages: "packages";
     /**

package/dist/lib/utils/entry-point.js

@@ -42,7 +42,7 @@ const general_1 = require("./general");
  */
 exports.EntryPointStrategy = {
     /**
-     * The default behavior in v0.22-v0.23, expects all provided entry points as being part of a single program.
+     * The default behavior in v0.22+, expects all provided entry points as being part of a single program.
      * Any directories included in the entry point list will result in `dir/index.([cm][tj]s|[tj]sx?)` being used.
      */
     Resolve: "resolve",
@@ -52,8 +52,8 @@ exports.EntryPointStrategy = {
      */
     Expand: "expand",
     /**
-     * Run TypeDoc in each directory passed as an entry point, and save the json result to `.typedoc/<project>`
-     * Once all have been saved, use the merge option to produce final output.
+     * Run TypeDoc in each directory passed as an entry point. Once all directories have been converted,
+     * use the merge option to produce final output.
      */
     Packages: "packages",
     /**
@@ -315,7 +315,7 @@ function getEntryPointsForLegacyPackages(logger, packageGlobPaths, options) {
         results.push({
             displayName: typedocPackageConfig?.displayName ?? packageName,
             version: includeVersion
-                ? packageJson["version"]
+                ? packageJson["version"]?.replace(/^v/, "")
                 : void 0,
             readmeFile: discoverReadmeFile(logger, Path.join(packageJsonPath, ".."), typedocPackageConfig?.readmeFile),
             program,

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

@@ -53,6 +53,10 @@ export declare function discoverInParentDir<T extends {}>(name: string, dir: str
     file: string;
     content: T;
 } | undefined;
+export declare function discoverInParentDirExactMatch<T extends {}>(name: string, dir: string, read: (content: string) => T | undefined): {
+    file: string;
+    content: T;
+} | undefined;
 export declare function discoverPackageJson(dir: string): {
     file: string;
     content: {
@@ -61,3 +65,4 @@ export declare function discoverPackageJson(dir: string): {
         name: string;
     };
 } | undefined;
+export declare function findPackageForPath(sourcePath: string): string | undefined;

package/dist/lib/utils/fs.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.discoverPackageJson = exports.discoverInParentDir = exports.hasTsExtension = exports.glob = exports.copySync = exports.copy = exports.writeFile = exports.writeFileSync = exports.readFile = exports.normalizePath = exports.getCommonDirectory = exports.isDir = exports.isFile = void 0;
+exports.findPackageForPath = exports.discoverPackageJson = exports.discoverInParentDirExactMatch = exports.discoverInParentDir = exports.hasTsExtension = exports.glob = exports.copySync = exports.copy = exports.writeFile = exports.writeFileSync = exports.readFile = exports.normalizePath = exports.getCommonDirectory = exports.isDir = exports.isFile = void 0;
 const fs = __importStar(require("fs"));
 const fs_1 = require("fs");
 const minimatch_1 = require("minimatch");
@@ -287,8 +287,26 @@ function discoverInParentDir(name, dir, read) {
     }
 }
 exports.discoverInParentDir = discoverInParentDir;
+function discoverInParentDirExactMatch(name, dir, read) {
+    if (!isDir(dir))
+        return;
+    const reachedTopDirectory = (dirName) => dirName === (0, path_1.resolve)((0, path_1.join)(dirName, ".."));
+    while (!reachedTopDirectory(dir)) {
+        try {
+            const content = read(readFile((0, path_1.join)(dir, name)));
+            if (content != null) {
+                return { file: (0, path_1.join)(dir, name), content };
+            }
+        }
+        catch {
+            // Ignore, file didn't pass validation
+        }
+        dir = (0, path_1.resolve)((0, path_1.join)(dir, ".."));
+    }
+}
+exports.discoverInParentDirExactMatch = discoverInParentDirExactMatch;
 function discoverPackageJson(dir) {
-    return discoverInParentDir("package.json", dir, (content) => {
+    return discoverInParentDirExactMatch("package.json", dir, (content) => {
         const pkg = JSON.parse(content);
         if ((0, validation_1.validate)({ name: String, version: (0, validation_1.optional)(String) }, pkg)) {
             return pkg;
@@ -296,3 +314,18 @@ function discoverPackageJson(dir) {
     });
 }
 exports.discoverPackageJson = discoverPackageJson;
+// dir -> package name according to package.json in this or some parent dir
+const packageCache = new Map();
+function findPackageForPath(sourcePath) {
+    const dir = (0, path_1.dirname)(sourcePath);
+    const cache = packageCache.get(dir);
+    if (cache) {
+        return cache;
+    }
+    const packageJson = discoverPackageJson(dir);
+    if (packageJson) {
+        packageCache.set(dir, packageJson.content.name);
+        return packageJson.content.name;
+    }
+}
+exports.findPackageForPath = findPackageForPath;

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

@@ -69,6 +69,7 @@ export interface TypeDocOptionMap {
     excludeInternal: boolean;
     excludePrivate: boolean;
     excludeProtected: boolean;
+    excludeReferences: boolean;
     externalSymbolLinkMappings: ManuallyValidatedOption<Record<string, Record<string, string>>>;
     media: string;
     includes: string;

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

@@ -190,6 +190,8 @@ export declare class Options {
 /**
  * Binds an option to the given property. Does not register the option.
  *
+ * Note: This is a legacy experimental decorator, and will not work with TS 5.0 decorators
+ *
  * @since v0.16.3
  */
 export declare function BindOption<K extends keyof TypeDocOptionMap>(name: K): <IK extends PropertyKey>(target: ({
@@ -201,6 +203,9 @@ export declare function BindOption<K extends keyof TypeDocOptionMap>(name: K): <
 }, key: IK) => void;
 /**
  * Binds an option to the given property. Does not register the option.
+ *
+ * Note: This is a legacy experimental decorator, and will not work with TS 5.0 decorators
+ *
  * @since v0.16.3
  *
  * @privateRemarks

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

@@ -159,6 +159,11 @@ function addTypeDocOptions(options) {
         help: "Ignore protected variables and methods.",
         type: declaration_1.ParameterType.Boolean,
     });
+    options.addDeclaration({
+        name: "excludeReferences",
+        help: "If a symbol is exported multiple times, ignore all but the first export.",
+        type: declaration_1.ParameterType.Boolean,
+    });
     options.addDeclaration({
         name: "externalSymbolLinkMappings",
         help: "Define custom links for symbols not included in the documentation.",

package/package.json

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