typedoc 0.26.11 → 0.27.0-beta.1

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

@@ -1,6 +1,8 @@
-import { ContainerReflection, type DeclarationReflection, type DocumentReflection } from "../../models/reflections/index";
-import { ReflectionGroup } from "../../models/ReflectionGroup";
-import { ConverterComponent } from "../components";
+import { ContainerReflection, type DeclarationReflection, type DocumentReflection } from "../../models/reflections/index.js";
+import { ReflectionGroup } from "../../models/ReflectionGroup.js";
+import { ConverterComponent } from "../components.js";
+import type { Converter } from "../converter.js";
+import type { Internationalization } from "../../internationalization/index.js";
 /**
  * A handler that sorts and groups the found reflections in the resolving phase.
  *
@@ -8,21 +10,19 @@ import { ConverterComponent } from "../components";
  */
 export declare class GroupPlugin extends ConverterComponent {
     sortFunction: (reflections: Array<DeclarationReflection | DocumentReflection>) => void;
-    accessor boosts: Record<string, number>;
     accessor groupOrder: string[];
     accessor sortEntryPoints: boolean;
-    usedBoosts: Set<string>;
+    accessor groupReferencesByType: boolean;
     static WEIGHTS: string[];
-    /**
-     * Create a new GroupPlugin instance.
-     */
-    initialize(): void;
+    constructor(owner: Converter);
     /**
      * Triggered when the converter has finished resolving a project.
      *
      * @param context  The context object describing the current state the converter is in.
      */
     private onEndResolve;
+    private onRevive;
+    private setup;
     private group;
     /**
      * Extracts the groups for a given reflection.
@@ -31,6 +31,7 @@ export declare class GroupPlugin extends ConverterComponent {
      * If you change this, also update extractCategories in CategoryPlugin accordingly.
      */
     getGroups(reflection: DeclarationReflection | DocumentReflection): Set<string>;
+    static getGroups(reflection: DeclarationReflection | DocumentReflection, groupReferencesByType: boolean, internationalization: Internationalization): Set<string>;
     /**
      * Create a grouped representation of the given list of reflections.
      *

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

@@ -1,4 +1,3 @@
-"use strict";
 var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
     function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
     var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
@@ -33,48 +32,33 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
     }
     return useValue ? value : void 0;
 };
-var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
-    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
-    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GroupPlugin = void 0;
-const index_1 = require("../../models/reflections/index");
-const ReflectionGroup_1 = require("../../models/ReflectionGroup");
-const components_1 = require("../components");
-const converter_1 = require("../converter");
-const sort_1 = require("../../utils/sort");
-const utils_1 = require("../../utils");
-const models_1 = require("../../models");
+import { ReflectionKind, ContainerReflection, ReferenceReflection, } from "../../models/reflections/index.js";
+import { ReflectionGroup } from "../../models/ReflectionGroup.js";
+import { ConverterComponent } from "../components.js";
+import { getSortFunction } from "../../utils/sort.js";
+import { Option } from "../../utils/index.js";
+import { Comment } from "../../models/index.js";
+import { ConverterEvents } from "../converter-events.js";
+import { ApplicationEvents } from "../../application-events.js";
+import assert from "assert";
 // Same as the defaultKindSortOrder in sort.ts
 const defaultGroupOrder = [
-    index_1.ReflectionKind.Document,
-    index_1.ReflectionKind.Reference,
+    ReflectionKind.Document,
     // project is never a child so never added to a group
-    index_1.ReflectionKind.Module,
-    index_1.ReflectionKind.Namespace,
-    index_1.ReflectionKind.Enum,
-    index_1.ReflectionKind.EnumMember,
-    index_1.ReflectionKind.Class,
-    index_1.ReflectionKind.Interface,
-    index_1.ReflectionKind.TypeAlias,
-    index_1.ReflectionKind.Constructor,
-    index_1.ReflectionKind.Property,
-    index_1.ReflectionKind.Variable,
-    index_1.ReflectionKind.Function,
-    index_1.ReflectionKind.Accessor,
-    index_1.ReflectionKind.Method,
+    ReflectionKind.Module,
+    ReflectionKind.Namespace,
+    ReflectionKind.Enum,
+    ReflectionKind.EnumMember,
+    ReflectionKind.Class,
+    ReflectionKind.Interface,
+    ReflectionKind.TypeAlias,
+    ReflectionKind.Constructor,
+    ReflectionKind.Property,
+    ReflectionKind.Variable,
+    ReflectionKind.Function,
+    ReflectionKind.Accessor,
+    ReflectionKind.Method,
+    ReflectionKind.Reference,
     // others are never added to groups
 ];
 /**
@@ -83,47 +67,43 @@ const defaultGroupOrder = [
  * The handler sets the `groups` property of all container reflections.
  */
 let GroupPlugin = (() => {
-    var _GroupPlugin_boosts_accessor_storage, _GroupPlugin_groupOrder_accessor_storage, _GroupPlugin_sortEntryPoints_accessor_storage;
-    let _classDecorators = [(0, components_1.Component)({ name: "group" })];
-    let _classDescriptor;
-    let _classExtraInitializers = [];
-    let _classThis;
-    let _classSuper = components_1.ConverterComponent;
-    let _boosts_decorators;
-    let _boosts_initializers = [];
-    let _boosts_extraInitializers = [];
+    let _classSuper = ConverterComponent;
     let _groupOrder_decorators;
     let _groupOrder_initializers = [];
     let _groupOrder_extraInitializers = [];
     let _sortEntryPoints_decorators;
     let _sortEntryPoints_initializers = [];
     let _sortEntryPoints_extraInitializers = [];
-    var GroupPlugin = _classThis = class extends _classSuper {
-        constructor() {
-            super(...arguments);
-            _GroupPlugin_boosts_accessor_storage.set(this, __runInitializers(this, _boosts_initializers, void 0));
-            _GroupPlugin_groupOrder_accessor_storage.set(this, (__runInitializers(this, _boosts_extraInitializers), __runInitializers(this, _groupOrder_initializers, void 0)));
-            _GroupPlugin_sortEntryPoints_accessor_storage.set(this, (__runInitializers(this, _groupOrder_extraInitializers), __runInitializers(this, _sortEntryPoints_initializers, void 0)));
-            this.usedBoosts = (__runInitializers(this, _sortEntryPoints_extraInitializers), new Set());
+    let _groupReferencesByType_decorators;
+    let _groupReferencesByType_initializers = [];
+    let _groupReferencesByType_extraInitializers = [];
+    return class GroupPlugin extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _groupOrder_decorators = [Option("groupOrder")];
+            _sortEntryPoints_decorators = [Option("sortEntryPoints")];
+            _groupReferencesByType_decorators = [Option("groupReferencesByType")];
+            __esDecorate(this, null, _groupOrder_decorators, { kind: "accessor", name: "groupOrder", static: false, private: false, access: { has: obj => "groupOrder" in obj, get: obj => obj.groupOrder, set: (obj, value) => { obj.groupOrder = value; } }, metadata: _metadata }, _groupOrder_initializers, _groupOrder_extraInitializers);
+            __esDecorate(this, null, _sortEntryPoints_decorators, { kind: "accessor", name: "sortEntryPoints", static: false, private: false, access: { has: obj => "sortEntryPoints" in obj, get: obj => obj.sortEntryPoints, set: (obj, value) => { obj.sortEntryPoints = value; } }, metadata: _metadata }, _sortEntryPoints_initializers, _sortEntryPoints_extraInitializers);
+            __esDecorate(this, null, _groupReferencesByType_decorators, { kind: "accessor", name: "groupReferencesByType", static: false, private: false, access: { has: obj => "groupReferencesByType" in obj, get: obj => obj.groupReferencesByType, set: (obj, value) => { obj.groupReferencesByType = value; } }, metadata: _metadata }, _groupReferencesByType_initializers, _groupReferencesByType_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         }
-        get boosts() { return __classPrivateFieldGet(this, _GroupPlugin_boosts_accessor_storage, "f"); }
-        set boosts(value) { __classPrivateFieldSet(this, _GroupPlugin_boosts_accessor_storage, value, "f"); }
-        get groupOrder() { return __classPrivateFieldGet(this, _GroupPlugin_groupOrder_accessor_storage, "f"); }
-        set groupOrder(value) { __classPrivateFieldSet(this, _GroupPlugin_groupOrder_accessor_storage, value, "f"); }
-        get sortEntryPoints() { return __classPrivateFieldGet(this, _GroupPlugin_sortEntryPoints_accessor_storage, "f"); }
-        set sortEntryPoints(value) { __classPrivateFieldSet(this, _GroupPlugin_sortEntryPoints_accessor_storage, value, "f"); }
-        /**
-         * Create a new GroupPlugin instance.
-         */
-        initialize() {
-            this.owner.on(converter_1.Converter.EVENT_RESOLVE_BEGIN, () => {
-                this.sortFunction = (0, sort_1.getSortFunction)(this.application.options);
-                GroupPlugin.WEIGHTS = this.groupOrder;
-                if (GroupPlugin.WEIGHTS.length === 0) {
-                    GroupPlugin.WEIGHTS = defaultGroupOrder.map((kind) => this.application.internationalization.kindPluralString(kind));
-                }
-            }, -100);
-            this.owner.on(converter_1.Converter.EVENT_RESOLVE_END, this.onEndResolve.bind(this), -100);
+        sortFunction;
+        #groupOrder_accessor_storage = __runInitializers(this, _groupOrder_initializers, void 0);
+        get groupOrder() { return this.#groupOrder_accessor_storage; }
+        set groupOrder(value) { this.#groupOrder_accessor_storage = value; }
+        #sortEntryPoints_accessor_storage = (__runInitializers(this, _groupOrder_extraInitializers), __runInitializers(this, _sortEntryPoints_initializers, void 0));
+        get sortEntryPoints() { return this.#sortEntryPoints_accessor_storage; }
+        set sortEntryPoints(value) { this.#sortEntryPoints_accessor_storage = value; }
+        #groupReferencesByType_accessor_storage = (__runInitializers(this, _sortEntryPoints_extraInitializers), __runInitializers(this, _groupReferencesByType_initializers, void 0));
+        get groupReferencesByType() { return this.#groupReferencesByType_accessor_storage; }
+        set groupReferencesByType(value) { this.#groupReferencesByType_accessor_storage = value; }
+        static WEIGHTS = [];
+        constructor(owner) {
+            super(owner);
+            __runInitializers(this, _groupReferencesByType_extraInitializers);
+            this.owner.on(ConverterEvents.RESOLVE_END, this.onEndResolve.bind(this), -100);
+            this.application.on(ApplicationEvents.REVIVE, this.onRevive.bind(this), -100);
         }
         /**
          * Triggered when the converter has finished resolving a project.
@@ -131,28 +111,35 @@ let GroupPlugin = (() => {
          * @param context  The context object describing the current state the converter is in.
          */
         onEndResolve(context) {
+            this.setup();
             this.group(context.project);
             for (const id in context.project.reflections) {
                 const reflection = context.project.reflections[id];
-                if (reflection instanceof index_1.ContainerReflection) {
+                if (reflection instanceof ContainerReflection) {
                     this.group(reflection);
                 }
             }
-            const unusedBoosts = new Set(Object.keys(this.boosts));
-            for (const boost of this.usedBoosts) {
-                unusedBoosts.delete(boost);
+        }
+        onRevive(project) {
+            this.setup();
+            this.group(project);
+            for (const refl of project.getReflectionsByKind(ReflectionKind.SomeModule)) {
+                assert(refl.isDeclaration());
+                this.group(refl);
             }
-            this.usedBoosts.clear();
-            if (unusedBoosts.size &&
-                this.application.options.isSet("searchGroupBoosts")) {
-                context.logger.warn(context.i18n.not_all_search_group_boosts_used_0(Array.from(unusedBoosts).join("\n\t")));
+        }
+        setup() {
+            this.sortFunction = getSortFunction(this.application.options);
+            GroupPlugin.WEIGHTS = this.groupOrder;
+            if (GroupPlugin.WEIGHTS.length === 0) {
+                GroupPlugin.WEIGHTS = defaultGroupOrder.map((kind) => this.application.internationalization.kindPluralString(kind));
             }
         }
         group(reflection) {
             if (reflection.childrenIncludingDocuments && !reflection.groups) {
                 if (reflection.children) {
                     if (this.sortEntryPoints ||
-                        !reflection.children.some((c) => c.kindOf(index_1.ReflectionKind.Module))) {
+                        !reflection.children.some((c) => c.kindOf(ReflectionKind.Module))) {
                         this.sortFunction(reflection.children);
                         this.sortFunction(reflection.documents || []);
                         this.sortFunction(reflection.childrenIncludingDocuments);
@@ -172,17 +159,18 @@ let GroupPlugin = (() => {
          * If you change this, also update extractCategories in CategoryPlugin accordingly.
          */
         getGroups(reflection) {
+            return GroupPlugin.getGroups(reflection, this.groupReferencesByType, this.application.internationalization);
+        }
+        static getGroups(reflection, groupReferencesByType, internationalization) {
             const groups = new Set();
             function extractGroupTags(comment) {
                 if (!comment)
                     return;
-                (0, utils_1.removeIf)(comment.blockTags, (tag) => {
+                for (const tag of comment.blockTags) {
                     if (tag.tag === "@group") {
-                        groups.add(models_1.Comment.combineDisplayParts(tag.content).trim());
-                        return true;
+                        groups.add(Comment.combineDisplayParts(tag.content).trim());
                     }
-                    return false;
-                });
+                }
             }
             if (reflection.isDeclaration()) {
                 extractGroupTags(reflection.comment);
@@ -198,17 +186,15 @@ let GroupPlugin = (() => {
             }
             if (reflection.isDocument() && "group" in reflection.frontmatter) {
                 groups.add(String(reflection.frontmatter["group"]));
-                delete reflection.frontmatter["group"];
             }
             groups.delete("");
             if (groups.size === 0) {
-                groups.add(this.application.internationalization.kindPluralString(reflection.kind));
-            }
-            for (const group of groups) {
-                if (group in this.boosts) {
-                    this.usedBoosts.add(group);
-                    reflection.relevanceBoost =
-                        (reflection.relevanceBoost ?? 1) * this.boosts[group];
+                if (reflection instanceof ReferenceReflection &&
+                    groupReferencesByType) {
+                    groups.add(internationalization.kindPluralString(reflection.getTargetReflectionDeep().kind));
+                }
+                else {
+                    groups.add(internationalization.kindPluralString(reflection.kind));
                 }
             }
             return groups;
@@ -227,16 +213,16 @@ let GroupPlugin = (() => {
                 for (const name of this.getGroups(child)) {
                     let group = groups.get(name);
                     if (!group) {
-                        group = new ReflectionGroup_1.ReflectionGroup(name, child);
+                        group = new ReflectionGroup(name, child);
                         groups.set(name, group);
                     }
                     group.children.push(child);
                 }
             });
             if (parent.comment) {
-                (0, utils_1.removeIf)(parent.comment.blockTags, (tag) => {
+                for (const tag of parent.comment.blockTags) {
                     if (tag.tag === "@groupDescription") {
-                        const { header, body } = models_1.Comment.splitPartsToHeaderAndBody(tag.content);
+                        const { header, body } = Comment.splitPartsToHeaderAndBody(tag.content);
                         const cat = groups.get(header);
                         if (cat) {
                             cat.description = body;
@@ -244,10 +230,8 @@ let GroupPlugin = (() => {
                         else {
                             this.application.logger.warn(this.application.i18n.comment_for_0_includes_groupDescription_for_1_but_no_child_in_group(parent.getFriendlyFullName(), header));
                         }
-                        return true;
                     }
-                    return false;
-                });
+                }
             }
             return Array.from(groups.values()).sort(GroupPlugin.sortGroupCallback);
         }
@@ -275,26 +259,5 @@ let GroupPlugin = (() => {
             return aWeight - bWeight;
         }
     };
-    _GroupPlugin_boosts_accessor_storage = new WeakMap();
-    _GroupPlugin_groupOrder_accessor_storage = new WeakMap();
-    _GroupPlugin_sortEntryPoints_accessor_storage = new WeakMap();
-    __setFunctionName(_classThis, "GroupPlugin");
-    (() => {
-        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
-        _boosts_decorators = [(0, utils_1.Option)("searchGroupBoosts")];
-        _groupOrder_decorators = [(0, utils_1.Option)("groupOrder")];
-        _sortEntryPoints_decorators = [(0, utils_1.Option)("sortEntryPoints")];
-        __esDecorate(_classThis, null, _boosts_decorators, { kind: "accessor", name: "boosts", static: false, private: false, access: { has: obj => "boosts" in obj, get: obj => obj.boosts, set: (obj, value) => { obj.boosts = value; } }, metadata: _metadata }, _boosts_initializers, _boosts_extraInitializers);
-        __esDecorate(_classThis, null, _groupOrder_decorators, { kind: "accessor", name: "groupOrder", static: false, private: false, access: { has: obj => "groupOrder" in obj, get: obj => obj.groupOrder, set: (obj, value) => { obj.groupOrder = value; } }, metadata: _metadata }, _groupOrder_initializers, _groupOrder_extraInitializers);
-        __esDecorate(_classThis, null, _sortEntryPoints_decorators, { kind: "accessor", name: "sortEntryPoints", static: false, private: false, access: { has: obj => "sortEntryPoints" in obj, get: obj => obj.sortEntryPoints, set: (obj, value) => { obj.sortEntryPoints = value; } }, metadata: _metadata }, _sortEntryPoints_initializers, _sortEntryPoints_extraInitializers);
-        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
-        GroupPlugin = _classThis = _classDescriptor.value;
-        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
-    })();
-    _classThis.WEIGHTS = [];
-    (() => {
-        __runInitializers(_classThis, _classExtraInitializers);
-    })();
-    return GroupPlugin = _classThis;
 })();
-exports.GroupPlugin = GroupPlugin;
+export { GroupPlugin };

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

@@ -1,4 +1,5 @@
-import { ConverterComponent } from "../components";
+import { ConverterComponent } from "../components.js";
+import type { Converter } from "../converter.js";
 /**
  * A plugin that detects interface implementations of functions and
  * properties on classes and links them.
@@ -7,10 +8,7 @@ export declare class ImplementsPlugin extends ConverterComponent {
     private resolved;
     private postponed;
     private revivingSerialized;
-    /**
-     * Create a new ImplementsPlugin instance.
-     */
-    initialize(): void;
+    constructor(owner: Converter);
     /**
      * Mark all members of the given class to be the implementation of the matching interface member.
      */