typedoc 0.26.11 → 0.27.0-beta.0

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

@@ -1,5 +1,6 @@
-import { type DeclarationReflection, type DocumentReflection } from "../../models";
-import { ConverterComponent } from "../components";
+import { type DeclarationReflection, type DocumentReflection } from "../../models/index.js";
+import { ConverterComponent } from "../components.js";
+import type { Converter } from "../converter.js";
 /**
  * A handler that sorts and categorizes the found reflections in the resolving phase.
  *
@@ -10,18 +11,14 @@ export declare class CategoryPlugin extends ConverterComponent {
     accessor defaultCategory: string;
     accessor categoryOrder: string[];
     accessor categorizeByGroup: boolean;
-    accessor boosts: Record<string, number>;
-    usedBoosts: Set<string>;
     static defaultCategory: string;
     static WEIGHTS: string[];
-    /**
-     * Create a new CategoryPlugin instance.
-     */
-    initialize(): void;
+    constructor(owner: Converter);
+    private onRevive;
     /**
      * Triggered when the converter begins converting a project.
      */
-    private onBegin;
+    private setup;
     /**
      * Triggered when the converter has finished resolving a project.
      *
@@ -35,21 +32,9 @@ export declare class CategoryPlugin extends ConverterComponent {
      * Create a categorized representation of the given list of reflections.
      *
      * @param reflections  The reflections that should be categorized.
-     * @param categorySearchBoosts A user-supplied map of category titles, for computing a
-     *   relevance boost to be used when searching
      * @returns An array containing all children of the given reflection categorized
      */
     private getReflectionCategories;
-    /**
-     * Return the category of a given reflection.
-     *
-     * @param reflection The reflection.
-     * @returns The category the reflection belongs to
-     *
-     * @privateRemarks
-     * If you change this, also update getGroups in GroupPlugin accordingly.
-     */
-    private extractCategories;
     /**
      * Callback used to sort categories by name.
      *

package/dist/lib/converter/plugins/CategoryPlugin.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,40 +32,19 @@ 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.CategoryPlugin = void 0;
-const models_1 = require("../../models");
-const models_2 = require("../../models");
-const components_1 = require("../components");
-const converter_1 = require("../converter");
-const utils_1 = require("../../utils");
+import assert from "assert";
+import { ApplicationEvents } from "../../application-events.js";
+import { Comment, ContainerReflection, ReflectionCategory, ReflectionKind, } from "../../models/index.js";
+import { Option, getSortFunction } from "../../utils/index.js";
+import { ConverterComponent } from "../components.js";
+import { ConverterEvents } from "../converter-events.js";
 /**
  * A handler that sorts and categorizes the found reflections in the resolving phase.
  *
  * The handler sets the ´category´ property of all reflections.
  */
 let CategoryPlugin = (() => {
-    var _CategoryPlugin_defaultCategory_accessor_storage, _CategoryPlugin_categoryOrder_accessor_storage, _CategoryPlugin_categorizeByGroup_accessor_storage, _CategoryPlugin_boosts_accessor_storage;
-    let _classDecorators = [(0, components_1.Component)({ name: "category" })];
-    let _classDescriptor;
-    let _classExtraInitializers = [];
-    let _classThis;
-    let _classSuper = components_1.ConverterComponent;
+    let _classSuper = ConverterComponent;
     let _defaultCategory_decorators;
     let _defaultCategory_initializers = [];
     let _defaultCategory_extraInitializers = [];
@@ -76,38 +54,49 @@ let CategoryPlugin = (() => {
     let _categorizeByGroup_decorators;
     let _categorizeByGroup_initializers = [];
     let _categorizeByGroup_extraInitializers = [];
-    let _boosts_decorators;
-    let _boosts_initializers = [];
-    let _boosts_extraInitializers = [];
-    var CategoryPlugin = _classThis = class extends _classSuper {
-        constructor() {
-            super(...arguments);
-            _CategoryPlugin_defaultCategory_accessor_storage.set(this, __runInitializers(this, _defaultCategory_initializers, void 0));
-            _CategoryPlugin_categoryOrder_accessor_storage.set(this, (__runInitializers(this, _defaultCategory_extraInitializers), __runInitializers(this, _categoryOrder_initializers, void 0)));
-            _CategoryPlugin_categorizeByGroup_accessor_storage.set(this, (__runInitializers(this, _categoryOrder_extraInitializers), __runInitializers(this, _categorizeByGroup_initializers, void 0)));
-            _CategoryPlugin_boosts_accessor_storage.set(this, (__runInitializers(this, _categorizeByGroup_extraInitializers), __runInitializers(this, _boosts_initializers, void 0)));
-            this.usedBoosts = (__runInitializers(this, _boosts_extraInitializers), new Set());
+    return class CategoryPlugin extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _defaultCategory_decorators = [Option("defaultCategory")];
+            _categoryOrder_decorators = [Option("categoryOrder")];
+            _categorizeByGroup_decorators = [Option("categorizeByGroup")];
+            __esDecorate(this, null, _defaultCategory_decorators, { kind: "accessor", name: "defaultCategory", static: false, private: false, access: { has: obj => "defaultCategory" in obj, get: obj => obj.defaultCategory, set: (obj, value) => { obj.defaultCategory = value; } }, metadata: _metadata }, _defaultCategory_initializers, _defaultCategory_extraInitializers);
+            __esDecorate(this, null, _categoryOrder_decorators, { kind: "accessor", name: "categoryOrder", static: false, private: false, access: { has: obj => "categoryOrder" in obj, get: obj => obj.categoryOrder, set: (obj, value) => { obj.categoryOrder = value; } }, metadata: _metadata }, _categoryOrder_initializers, _categoryOrder_extraInitializers);
+            __esDecorate(this, null, _categorizeByGroup_decorators, { kind: "accessor", name: "categorizeByGroup", static: false, private: false, access: { has: obj => "categorizeByGroup" in obj, get: obj => obj.categorizeByGroup, set: (obj, value) => { obj.categorizeByGroup = value; } }, metadata: _metadata }, _categorizeByGroup_initializers, _categorizeByGroup_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         }
-        get defaultCategory() { return __classPrivateFieldGet(this, _CategoryPlugin_defaultCategory_accessor_storage, "f"); }
-        set defaultCategory(value) { __classPrivateFieldSet(this, _CategoryPlugin_defaultCategory_accessor_storage, value, "f"); }
-        get categoryOrder() { return __classPrivateFieldGet(this, _CategoryPlugin_categoryOrder_accessor_storage, "f"); }
-        set categoryOrder(value) { __classPrivateFieldSet(this, _CategoryPlugin_categoryOrder_accessor_storage, value, "f"); }
-        get categorizeByGroup() { return __classPrivateFieldGet(this, _CategoryPlugin_categorizeByGroup_accessor_storage, "f"); }
-        set categorizeByGroup(value) { __classPrivateFieldSet(this, _CategoryPlugin_categorizeByGroup_accessor_storage, value, "f"); }
-        get boosts() { return __classPrivateFieldGet(this, _CategoryPlugin_boosts_accessor_storage, "f"); }
-        set boosts(value) { __classPrivateFieldSet(this, _CategoryPlugin_boosts_accessor_storage, value, "f"); }
-        /**
-         * Create a new CategoryPlugin instance.
-         */
-        initialize() {
-            this.owner.on(converter_1.Converter.EVENT_BEGIN, this.onBegin.bind(this), -200);
-            this.owner.on(converter_1.Converter.EVENT_RESOLVE_END, this.onEndResolve.bind(this), -200);
+        sortFunction;
+        #defaultCategory_accessor_storage = __runInitializers(this, _defaultCategory_initializers, void 0);
+        get defaultCategory() { return this.#defaultCategory_accessor_storage; }
+        set defaultCategory(value) { this.#defaultCategory_accessor_storage = value; }
+        #categoryOrder_accessor_storage = (__runInitializers(this, _defaultCategory_extraInitializers), __runInitializers(this, _categoryOrder_initializers, void 0));
+        get categoryOrder() { return this.#categoryOrder_accessor_storage; }
+        set categoryOrder(value) { this.#categoryOrder_accessor_storage = value; }
+        #categorizeByGroup_accessor_storage = (__runInitializers(this, _categoryOrder_extraInitializers), __runInitializers(this, _categorizeByGroup_initializers, void 0));
+        get categorizeByGroup() { return this.#categorizeByGroup_accessor_storage; }
+        set categorizeByGroup(value) { this.#categorizeByGroup_accessor_storage = value; }
+        // For use in static methods
+        static defaultCategory = "Other";
+        static WEIGHTS = [];
+        constructor(owner) {
+            super(owner);
+            __runInitializers(this, _categorizeByGroup_extraInitializers);
+            this.owner.on(ConverterEvents.RESOLVE_END, this.onEndResolve.bind(this), -200);
+            this.application.on(ApplicationEvents.REVIVE, this.onRevive.bind(this), -200);
+        }
+        onRevive(project) {
+            this.setup();
+            this.categorize(project);
+            for (const refl of project.getReflectionsByKind(ReflectionKind.SomeModule)) {
+                assert(refl.isDeclaration());
+                this.categorize(refl);
+            }
         }
         /**
          * Triggered when the converter begins converting a project.
          */
-        onBegin(_context) {
-            this.sortFunction = (0, utils_1.getSortFunction)(this.application.options);
+        setup() {
+            this.sortFunction = getSortFunction(this.application.options);
             // Set up static properties
             if (this.defaultCategory) {
                 CategoryPlugin.defaultCategory = this.defaultCategory;
@@ -120,22 +109,15 @@ let CategoryPlugin = (() => {
          * @param context  The context object describing the current state the converter is in.
          */
         onEndResolve(context) {
+            this.setup();
             const project = context.project;
             this.categorize(project);
             for (const id in project.reflections) {
                 const reflection = project.reflections[id];
-                if (reflection instanceof models_1.ContainerReflection) {
+                if (reflection instanceof ContainerReflection) {
                     this.categorize(reflection);
                 }
             }
-            const unusedBoosts = new Set(Object.keys(this.boosts));
-            for (const boost of this.usedBoosts) {
-                unusedBoosts.delete(boost);
-            }
-            this.usedBoosts.clear();
-            if (unusedBoosts.size) {
-                context.logger.warn(context.i18n.not_all_search_category_boosts_used_0(Array.from(unusedBoosts).join("\n\t")));
-            }
         }
         categorize(obj) {
             if (this.categorizeByGroup) {
@@ -181,14 +163,12 @@ let CategoryPlugin = (() => {
          * Create a categorized representation of the given list of reflections.
          *
          * @param reflections  The reflections that should be categorized.
-         * @param categorySearchBoosts A user-supplied map of category titles, for computing a
-         *   relevance boost to be used when searching
          * @returns An array containing all children of the given reflection categorized
          */
         getReflectionCategories(parent, reflections) {
             const categories = new Map();
             for (const child of reflections) {
-                const childCategories = this.extractCategories(child);
+                const childCategories = CategoryPlugin.getCategories(child);
                 if (childCategories.size === 0) {
                     childCategories.add(CategoryPlugin.defaultCategory);
                 }
@@ -198,16 +178,16 @@ let CategoryPlugin = (() => {
                         category.children.push(child);
                     }
                     else {
-                        const cat = new models_2.ReflectionCategory(childCat);
+                        const cat = new ReflectionCategory(childCat);
                         cat.children.push(child);
                         categories.set(childCat, cat);
                     }
                 }
             }
             if (parent.comment) {
-                (0, utils_1.removeIf)(parent.comment.blockTags, (tag) => {
+                for (const tag of parent.comment.blockTags) {
                     if (tag.tag === "@categoryDescription") {
-                        const { header, body } = models_1.Comment.splitPartsToHeaderAndBody(tag.content);
+                        const { header, body } = Comment.splitPartsToHeaderAndBody(tag.content);
                         const cat = categories.get(header);
                         if (cat) {
                             cat.description = body;
@@ -215,53 +195,14 @@ let CategoryPlugin = (() => {
                         else {
                             this.application.logger.warn(this.application.i18n.comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group(parent.getFriendlyFullName(), header));
                         }
-                        return true;
                     }
-                    return false;
-                });
+                }
             }
             for (const cat of categories.values()) {
                 this.sortFunction(cat.children);
             }
             return Array.from(categories.values());
         }
-        /**
-         * Return the category of a given reflection.
-         *
-         * @param reflection The reflection.
-         * @returns The category the reflection belongs to
-         *
-         * @privateRemarks
-         * If you change this, also update getGroups in GroupPlugin accordingly.
-         */
-        extractCategories(reflection) {
-            const categories = CategoryPlugin.getCategories(reflection);
-            reflection.comment?.removeTags("@category");
-            if (reflection.isDeclaration()) {
-                for (const sig of reflection.getNonIndexSignatures()) {
-                    sig.comment?.removeTags("@category");
-                }
-                if (reflection.type?.type === "reflection") {
-                    reflection.type.declaration.comment?.removeTags("@category");
-                    for (const sig of reflection.type.declaration.getNonIndexSignatures()) {
-                        sig.comment?.removeTags("@category");
-                    }
-                }
-            }
-            if (reflection.isDocument() && "category" in reflection.frontmatter) {
-                categories.add(String(reflection.frontmatter["category"]));
-                delete reflection.frontmatter["category"];
-            }
-            categories.delete("");
-            for (const cat of categories) {
-                if (cat in this.boosts) {
-                    this.usedBoosts.add(cat);
-                    reflection.relevanceBoost =
-                        (reflection.relevanceBoost ?? 1) * this.boosts[cat];
-                }
-            }
-            return categories;
-        }
         /**
          * Callback used to sort categories by name.
          *
@@ -296,7 +237,7 @@ let CategoryPlugin = (() => {
                     return;
                 for (const tag of comment.blockTags) {
                     if (tag.tag === "@category") {
-                        categories.add(models_1.Comment.combineDisplayParts(tag.content).trim());
+                        categories.add(Comment.combineDisplayParts(tag.content).trim());
                     }
                 }
             }
@@ -312,35 +253,12 @@ let CategoryPlugin = (() => {
                     }
                 }
             }
+            if (reflection.isDocument() && "category" in reflection.frontmatter) {
+                categories.add(String(reflection.frontmatter["category"]));
+            }
             categories.delete("");
             return categories;
         }
     };
-    _CategoryPlugin_defaultCategory_accessor_storage = new WeakMap();
-    _CategoryPlugin_categoryOrder_accessor_storage = new WeakMap();
-    _CategoryPlugin_categorizeByGroup_accessor_storage = new WeakMap();
-    _CategoryPlugin_boosts_accessor_storage = new WeakMap();
-    __setFunctionName(_classThis, "CategoryPlugin");
-    (() => {
-        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
-        _defaultCategory_decorators = [(0, utils_1.Option)("defaultCategory")];
-        _categoryOrder_decorators = [(0, utils_1.Option)("categoryOrder")];
-        _categorizeByGroup_decorators = [(0, utils_1.Option)("categorizeByGroup")];
-        _boosts_decorators = [(0, utils_1.Option)("searchCategoryBoosts")];
-        __esDecorate(_classThis, null, _defaultCategory_decorators, { kind: "accessor", name: "defaultCategory", static: false, private: false, access: { has: obj => "defaultCategory" in obj, get: obj => obj.defaultCategory, set: (obj, value) => { obj.defaultCategory = value; } }, metadata: _metadata }, _defaultCategory_initializers, _defaultCategory_extraInitializers);
-        __esDecorate(_classThis, null, _categoryOrder_decorators, { kind: "accessor", name: "categoryOrder", static: false, private: false, access: { has: obj => "categoryOrder" in obj, get: obj => obj.categoryOrder, set: (obj, value) => { obj.categoryOrder = value; } }, metadata: _metadata }, _categoryOrder_initializers, _categoryOrder_extraInitializers);
-        __esDecorate(_classThis, null, _categorizeByGroup_decorators, { kind: "accessor", name: "categorizeByGroup", static: false, private: false, access: { has: obj => "categorizeByGroup" in obj, get: obj => obj.categorizeByGroup, set: (obj, value) => { obj.categorizeByGroup = value; } }, metadata: _metadata }, _categorizeByGroup_initializers, _categorizeByGroup_extraInitializers);
-        __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(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
-        CategoryPlugin = _classThis = _classDescriptor.value;
-        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
-    })();
-    // For use in static methods
-    _classThis.defaultCategory = "Other";
-    _classThis.WEIGHTS = [];
-    (() => {
-        __runInitializers(_classThis, _classExtraInitializers);
-    })();
-    return CategoryPlugin = _classThis;
 })();
-exports.CategoryPlugin = CategoryPlugin;
+export { CategoryPlugin };

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

@@ -1,4 +1,5 @@
-import { ConverterComponent } from "../components";
+import { ConverterComponent } from "../components.js";
+import type { Converter } from "../converter.js";
 /**
  * Handles most behavior triggered by comments. `@group` and `@category` are handled by their respective plugins, but everything else is here.
  *
@@ -66,10 +67,7 @@ export declare class CommentPlugin extends ConverterComponent {
     accessor defaultCategory: string;
     private _excludeKinds;
     private get excludeNotDocumentedKinds();
-    /**
-     * Create a new CommentPlugin instance.
-     */
-    initialize(): void;
+    constructor(owner: Converter);
     /**
      * Apply all comment tag modifiers to the given reflection.
      *