typedoc 0.26.11 → 0.27.0-beta.0

package/dist/lib/models/reflections/abstract.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,13 +32,10 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
     }
     return useValue ? value : void 0;
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Reflection = exports.TraverseProperty = exports.ReflectionFlags = exports.ReflectionFlag = void 0;
-exports.resetReflectionID = resetReflectionID;
-const comment_1 = require("../comments/comment");
-const utils_1 = require("./utils");
-const kind_1 = require("./kind");
-const general_1 = require("../../utils/general");
+import { Comment } from "../comments/comment.js";
+import { splitUnquotedString } from "./utils.js";
+import { ReflectionKind } from "./kind.js";
+import { NonEnumerable } from "../../utils/general.js";
 /**
  * Current reflection id.
  */
@@ -49,10 +45,10 @@ let REFLECTION_ID = 0;
  *
  * Used by the test cases to ensure the reflection ids won't change between runs.
  */
-function resetReflectionID() {
+export function resetReflectionID() {
     REFLECTION_ID = 0;
 }
-var ReflectionFlag;
+export var ReflectionFlag;
 (function (ReflectionFlag) {
     ReflectionFlag[ReflectionFlag["None"] = 0] = "None";
     ReflectionFlag[ReflectionFlag["Private"] = 1] = "Private";
@@ -66,13 +62,12 @@ var ReflectionFlag;
     ReflectionFlag[ReflectionFlag["Const"] = 256] = "Const";
     ReflectionFlag[ReflectionFlag["Readonly"] = 512] = "Readonly";
     ReflectionFlag[ReflectionFlag["Inherited"] = 1024] = "Inherited";
-})(ReflectionFlag || (exports.ReflectionFlag = ReflectionFlag = {}));
+})(ReflectionFlag || (ReflectionFlag = {}));
 const relevantFlags = [
     ReflectionFlag.Private,
     ReflectionFlag.Protected,
     ReflectionFlag.Static,
     ReflectionFlag.Optional,
-    ReflectionFlag.Rest,
     ReflectionFlag.Abstract,
     ReflectionFlag.Const,
     ReflectionFlag.Readonly,
@@ -80,10 +75,8 @@ const relevantFlags = [
 /**
  * This must extend Array in order to work with Handlebar's each helper.
  */
-class ReflectionFlags {
-    constructor() {
-        this.flags = ReflectionFlag.None;
-    }
+export class ReflectionFlags {
+    flags = ReflectionFlag.None;
     hasFlag(flag) {
         return (flag & this.flags) !== 0;
     }
@@ -187,6 +180,19 @@ class ReflectionFlags {
             this.flags |= flag;
         }
     }
+    static serializedFlags = [
+        "isPrivate",
+        "isProtected",
+        "isPublic",
+        "isStatic",
+        "isExternal",
+        "isOptional",
+        "isRest",
+        "isAbstract",
+        "isConst",
+        "isReadonly",
+        "isInherited",
+    ];
     toObject() {
         return Object.fromEntries(ReflectionFlags.serializedFlags
             .filter((flag) => this[flag])
@@ -201,21 +207,7 @@ class ReflectionFlags {
         }
     }
 }
-exports.ReflectionFlags = ReflectionFlags;
-ReflectionFlags.serializedFlags = [
-    "isPrivate",
-    "isProtected",
-    "isPublic",
-    "isStatic",
-    "isExternal",
-    "isOptional",
-    "isRest",
-    "isAbstract",
-    "isConst",
-    "isReadonly",
-    "isInherited",
-];
-var TraverseProperty;
+export var TraverseProperty;
 (function (TraverseProperty) {
     TraverseProperty[TraverseProperty["Children"] = 0] = "Children";
     TraverseProperty[TraverseProperty["Documents"] = 1] = "Documents";
@@ -226,7 +218,7 @@ var TraverseProperty;
     TraverseProperty[TraverseProperty["IndexSignature"] = 6] = "IndexSignature";
     TraverseProperty[TraverseProperty["GetSignature"] = 7] = "GetSignature";
     TraverseProperty[TraverseProperty["SetSignature"] = 8] = "SetSignature";
-})(TraverseProperty || (exports.TraverseProperty = TraverseProperty = {}));
+})(TraverseProperty || (TraverseProperty = {}));
 /**
  * Base class for all reflection classes.
  *
@@ -240,243 +232,244 @@ var TraverseProperty;
  * @category Reflections
  */
 let Reflection = (() => {
-    var _a;
     let _parent_decorators;
     let _parent_initializers = [];
     let _parent_extraInitializers = [];
     let _project_decorators;
     let _project_initializers = [];
     let _project_extraInitializers = [];
-    return _a = class Reflection {
-            constructor(name, kind, parent) {
-                this.flags = new ReflectionFlags();
-                /**
-                 * The reflection this reflection is a child of.
-                 */
-                this.parent = __runInitializers(this, _parent_initializers, void 0);
-                this.project = (__runInitializers(this, _parent_extraInitializers), __runInitializers(this, _project_initializers, void 0));
-                /**
-                 * The parsed documentation comment attached to this reflection.
-                 */
-                this.comment = __runInitializers(this, _project_extraInitializers);
-                this.id = REFLECTION_ID++;
-                this.parent = parent;
-                this.project = parent?.project || this;
-                this.name = name;
-                this.kind = kind;
-                // If our parent is external, we are too.
-                if (parent?.flags.isExternal) {
-                    this.setFlag(ReflectionFlag.External);
-                }
-            }
-            /**
-             * Test whether this reflection is of the given kind.
-             */
-            kindOf(kind) {
-                const kindFlags = Array.isArray(kind)
-                    ? kind.reduce((a, b) => a | b, 0)
-                    : kind;
-                return (this.kind & kindFlags) !== 0;
-            }
-            /**
-             * Return the full name of this reflection. Intended for use in debugging. For log messages
-             * intended to be displayed to the user for them to fix, prefer {@link getFriendlyFullName} instead.
-             *
-             * The full name contains the name of this reflection and the names of all parent reflections.
-             *
-             * @param separator  Separator used to join the names of the reflections.
-             * @returns The full name of this reflection.
-             */
-            getFullName(separator = ".") {
-                if (this.parent && !this.parent.isProject()) {
-                    return this.parent.getFullName(separator) + separator + this.name;
-                }
-                else {
-                    return this.name;
-                }
-            }
-            /**
-             * Return the full name of this reflection, with signature names dropped if possible without
-             * introducing ambiguity in the name.
-             */
-            getFriendlyFullName() {
-                if (this.parent && !this.parent.isProject()) {
-                    if (this.kindOf(kind_1.ReflectionKind.ConstructorSignature |
-                        kind_1.ReflectionKind.CallSignature |
-                        kind_1.ReflectionKind.GetSignature |
-                        kind_1.ReflectionKind.SetSignature)) {
-                        return this.parent.getFriendlyFullName();
-                    }
-                    return this.parent.getFriendlyFullName() + "." + this.name;
-                }
-                else {
-                    return this.name;
-                }
+    return class Reflection {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+            _parent_decorators = [NonEnumerable];
+            _project_decorators = [NonEnumerable];
+            __esDecorate(null, null, _parent_decorators, { kind: "field", name: "parent", static: false, private: false, access: { has: obj => "parent" in obj, get: obj => obj.parent, set: (obj, value) => { obj.parent = value; } }, metadata: _metadata }, _parent_initializers, _parent_extraInitializers);
+            __esDecorate(null, null, _project_decorators, { kind: "field", name: "project", static: false, private: false, access: { has: obj => "project" in obj, get: obj => obj.project, set: (obj, value) => { obj.project = value; } }, metadata: _metadata }, _project_initializers, _project_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        }
+        /**
+         * Unique id of this reflection.
+         */
+        id;
+        /**
+         * The symbol name of this reflection.
+         */
+        name;
+        /**
+         * The kind of this reflection.
+         */
+        kind;
+        flags = new ReflectionFlags();
+        /**
+         * The reflection this reflection is a child of.
+         */
+        parent = __runInitializers(this, _parent_initializers, void 0);
+        project = (__runInitializers(this, _parent_extraInitializers), __runInitializers(this, _project_initializers, void 0));
+        /**
+         * The parsed documentation comment attached to this reflection.
+         */
+        comment = __runInitializers(this, _project_extraInitializers);
+        /**
+         * The url of this reflection in the generated documentation.
+         * TODO: Reflections shouldn't know urls exist. Move this to a serializer.
+         */
+        url;
+        /**
+         * The name of the anchor of this child.
+         * TODO: Reflections shouldn't know anchors exist. Move this to a serializer.
+         */
+        anchor;
+        /**
+         * Is the url pointing to an individual document?
+         *
+         * When FALSE, the url points to an anchor tag on a page of a different reflection.
+         * TODO: Reflections shouldn't know how they are rendered. Move this to the correct serializer.
+         */
+        hasOwnDocument;
+        constructor(name, kind, parent) {
+            this.id = REFLECTION_ID++;
+            this.parent = parent;
+            this.project = parent?.project || this;
+            this.name = name;
+            this.kind = kind;
+            // If our parent is external, we are too.
+            if (parent?.flags.isExternal) {
+                this.setFlag(ReflectionFlag.External);
             }
-            /**
-             * Set a flag on this reflection.
-             */
-            setFlag(flag, value = true) {
-                this.flags.setFlag(flag, value);
+        }
+        /**
+         * Test whether this reflection is of the given kind.
+         */
+        kindOf(kind) {
+            const kindFlags = Array.isArray(kind)
+                ? kind.reduce((a, b) => a | b, 0)
+                : kind;
+            return (this.kind & kindFlags) !== 0;
+        }
+        /**
+         * Return the full name of this reflection. Intended for use in debugging. For log messages
+         * intended to be displayed to the user for them to fix, prefer {@link getFriendlyFullName} instead.
+         *
+         * The full name contains the name of this reflection and the names of all parent reflections.
+         *
+         * @param separator  Separator used to join the names of the reflections.
+         * @returns The full name of this reflection.
+         */
+        getFullName(separator = ".") {
+            if (this.parent && !this.parent.isProject()) {
+                return this.parent.getFullName(separator) + separator + this.name;
             }
-            /**
-             * Return an url safe alias for this reflection.
-             */
-            getAlias() {
-                this._alias ||= this.getUniqueAliasInPage(this.name.replace(/\W/g, "_") || `reflection-${this.id}`);
-                return this._alias;
+            else {
+                return this.name;
             }
-            // This really ought not live here, it ought to live in the html renderer, but moving that
-            // is more work than I want right now, it can wait for 0.27 when trying to split models into
-            // a bundleable structure.
-            getUniqueAliasInPage(heading) {
-                // NTFS/ExFAT use uppercase, so we will too. It probably won't matter
-                // in this case since names will generally be valid identifiers, but to be safe...
-                const upperAlias = heading.toUpperCase();
-                let target = this;
-                while (target.parent && !target.hasOwnDocument) {
-                    target = target.parent;
-                }
-                target._aliases ||= new Map();
-                let suffix = "";
-                if (!target._aliases.has(upperAlias)) {
-                    target._aliases.set(upperAlias, 1);
-                }
-                else {
-                    const count = target._aliases.get(upperAlias);
-                    suffix = "-" + count.toString();
-                    target._aliases.set(upperAlias, count + 1);
+        }
+        /**
+         * Return the full name of this reflection, with signature names dropped if possible without
+         * introducing ambiguity in the name.
+         */
+        getFriendlyFullName() {
+            if (this.parent && !this.parent.isProject()) {
+                if (this.kindOf(ReflectionKind.ConstructorSignature |
+                    ReflectionKind.CallSignature |
+                    ReflectionKind.GetSignature |
+                    ReflectionKind.SetSignature)) {
+                    return this.parent.getFriendlyFullName();
                 }
-                heading += suffix;
-                return heading;
+                return this.parent.getFriendlyFullName() + "." + this.name;
             }
-            /**
-             * Has this reflection a visible comment?
-             *
-             * @returns TRUE when this reflection has a visible comment.
-             */
-            hasComment() {
-                return this.comment ? this.comment.hasVisibleComponent() : false;
+            else {
+                return this.name;
             }
-            hasGetterOrSetter() {
-                return false;
-            }
-            /**
-             * Return a child by its name.
-             *
-             * @param arg The name hierarchy of the child to look for.
-             * @returns The found child or undefined.
-             */
-            getChildByName(arg) {
-                const names = Array.isArray(arg)
-                    ? arg
-                    : (0, utils_1.splitUnquotedString)(arg, ".");
-                const name = names[0];
-                let result;
-                this.traverse((child) => {
-                    if (child.name === name) {
-                        if (names.length <= 1) {
-                            result = child;
-                        }
-                        else {
-                            result = child.getChildByName(names.slice(1));
-                        }
-                        return false;
+        }
+        /**
+         * Set a flag on this reflection.
+         */
+        setFlag(flag, value = true) {
+            this.flags.setFlag(flag, value);
+        }
+        /**
+         * Has this reflection a visible comment?
+         *
+         * @returns TRUE when this reflection has a visible comment.
+         */
+        hasComment() {
+            return this.comment ? this.comment.hasVisibleComponent() : false;
+        }
+        hasGetterOrSetter() {
+            return false;
+        }
+        /**
+         * Return a child by its name.
+         *
+         * @param arg The name hierarchy of the child to look for.
+         * @returns The found child or undefined.
+         */
+        getChildByName(arg) {
+            const names = Array.isArray(arg)
+                ? arg
+                : splitUnquotedString(arg, ".");
+            const name = names[0];
+            let result;
+            this.traverse((child) => {
+                if (child.name === name) {
+                    if (names.length <= 1) {
+                        result = child;
                     }
-                    return true;
-                });
-                return result;
-            }
-            /**
-             * Return whether this reflection is the root / project reflection.
-             */
-            isProject() {
-                return false;
-            }
-            isDeclaration() {
-                return false;
-            }
-            isDocument() {
-                return false;
-            }
-            /**
-             * Check if this reflection or any of its parents have been marked with the `@deprecated` tag.
-             */
-            isDeprecated() {
-                let signaturesDeprecated = false;
-                this.visit({
-                    declaration(decl) {
-                        if (decl.signatures?.length &&
-                            decl.signatures.every((sig) => sig.comment?.getTag("@deprecated"))) {
-                            signaturesDeprecated = true;
-                        }
-                    },
-                });
-                if (signaturesDeprecated || this.comment?.getTag("@deprecated")) {
-                    return true;
+                    else {
+                        result = child.getChildByName(names.slice(1));
+                    }
+                    return false;
                 }
-                return this.parent?.isDeprecated() ?? false;
-            }
-            visit(visitor) {
-                visitor[this.variant]?.(this);
-            }
-            /**
-             * Return a string representation of this reflection.
-             */
-            toString() {
-                return kind_1.ReflectionKind[this.kind] + " " + this.name;
-            }
-            /**
-             * Return a string representation of this reflection and all of its children.
-             *
-             * Note: This is intended as a debug tool only, output may change between patch versions.
-             *
-             * @param indent  Used internally to indent child reflections.
-             */
-            toStringHierarchy(indent = "") {
-                const lines = [indent + this.toString()];
-                indent += "  ";
-                this.traverse((child) => {
-                    lines.push(child.toStringHierarchy(indent));
-                    return true;
-                });
-                return lines.join("\n");
-            }
-            toObject(serializer) {
-                return {
-                    id: this.id,
-                    name: this.name,
-                    variant: this.variant,
-                    kind: this.kind,
-                    flags: this.flags.toObject(),
-                    comment: this.comment && !this.comment.isEmpty()
-                        ? serializer.toObject(this.comment)
-                        : undefined,
-                };
-            }
-            fromObject(de, obj) {
-                // DO NOT copy id from obj. When deserializing reflections
-                // they should be given new ids since they belong to a different project.
-                this.name = obj.name;
-                // Skip copying variant, we know it's already the correct value because the deserializer
-                // will construct the correct class type.
-                this.kind = obj.kind;
-                this.flags.fromObject(obj.flags);
-                // Parent is set during construction, so we don't need to do it here.
-                this.comment = de.revive(obj.comment, () => new comment_1.Comment());
-                // url, anchor, hasOwnDocument, _alias, _aliases are set during rendering and only relevant during render.
-                // It doesn't make sense to serialize them to json, or restore them.
+                return true;
+            });
+            return result;
+        }
+        /**
+         * Return whether this reflection is the root / project reflection.
+         */
+        isProject() {
+            return false;
+        }
+        isDeclaration() {
+            return false;
+        }
+        isParameter() {
+            return false;
+        }
+        isDocument() {
+            return false;
+        }
+        isReference() {
+            return this.variant === "reference";
+        }
+        /**
+         * Check if this reflection or any of its parents have been marked with the `@deprecated` tag.
+         */
+        isDeprecated() {
+            let signaturesDeprecated = false;
+            this.visit({
+                declaration(decl) {
+                    if (decl.signatures?.length &&
+                        decl.signatures.every((sig) => sig.comment?.getTag("@deprecated"))) {
+                        signaturesDeprecated = true;
+                    }
+                },
+            });
+            if (signaturesDeprecated || this.comment?.getTag("@deprecated")) {
+                return true;
             }
-        },
-        (() => {
-            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
-            _parent_decorators = [general_1.NonEnumerable // So that it doesn't show up in console.log
-            ];
-            _project_decorators = [general_1.NonEnumerable];
-            __esDecorate(null, null, _parent_decorators, { kind: "field", name: "parent", static: false, private: false, access: { has: obj => "parent" in obj, get: obj => obj.parent, set: (obj, value) => { obj.parent = value; } }, metadata: _metadata }, _parent_initializers, _parent_extraInitializers);
-            __esDecorate(null, null, _project_decorators, { kind: "field", name: "project", static: false, private: false, access: { has: obj => "project" in obj, get: obj => obj.project, set: (obj, value) => { obj.project = value; } }, metadata: _metadata }, _project_initializers, _project_extraInitializers);
-            if (_metadata) Object.defineProperty(_a, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
-        })(),
-        _a;
+            return this.parent?.isDeprecated() ?? false;
+        }
+        visit(visitor) {
+            visitor[this.variant]?.(this);
+        }
+        /**
+         * Return a string representation of this reflection.
+         */
+        toString() {
+            return ReflectionKind[this.kind] + " " + this.name;
+        }
+        /**
+         * Return a string representation of this reflection and all of its children.
+         *
+         * Note: This is intended as a debug tool only, output may change between patch versions.
+         *
+         * @param indent  Used internally to indent child reflections.
+         */
+        toStringHierarchy(indent = "") {
+            const lines = [indent + this.toString()];
+            indent += "  ";
+            this.traverse((child) => {
+                lines.push(child.toStringHierarchy(indent));
+                return true;
+            });
+            return lines.join("\n");
+        }
+        toObject(serializer) {
+            return {
+                id: this.id,
+                name: this.name,
+                variant: this.variant,
+                kind: this.kind,
+                flags: this.flags.toObject(),
+                comment: this.comment && !this.comment.isEmpty()
+                    ? serializer.toObject(this.comment)
+                    : undefined,
+            };
+        }
+        fromObject(de, obj) {
+            // DO NOT copy id from obj. When deserializing reflections
+            // they should be given new ids since they belong to a different project.
+            this.name = obj.name;
+            // Skip copying variant, we know it's already the correct value because the deserializer
+            // will construct the correct class type.
+            this.kind = obj.kind;
+            this.flags.fromObject(obj.flags);
+            // Parent is set during construction, so we don't need to do it here.
+            this.comment = de.revive(obj.comment, () => new Comment());
+            // url, anchor, hasOwnDocument, _alias, _aliases are set during rendering and only relevant during render.
+            // It doesn't make sense to serialize them to json, or restore them.
+        }
+    };
 })();
-exports.Reflection = Reflection;
+export { Reflection };

package/dist/lib/models/reflections/container.d.ts

@@ -1,10 +1,10 @@
-import { Reflection, type TraverseCallback } from "./abstract";
-import { ReflectionCategory } from "../ReflectionCategory";
-import { ReflectionGroup } from "../ReflectionGroup";
-import type { ReflectionKind } from "./kind";
-import type { Serializer, JSONOutput, Deserializer } from "../../serialization";
-import type { DocumentReflection } from "./document";
-import type { DeclarationReflection } from "./declaration";
+import { Reflection, type TraverseCallback } from "./abstract.js";
+import { ReflectionCategory } from "../ReflectionCategory.js";
+import { ReflectionGroup } from "../ReflectionGroup.js";
+import type { ReflectionKind } from "./kind.js";
+import type { Serializer, JSONOutput, Deserializer } from "../../serialization/index.js";
+import type { DocumentReflection } from "./document.js";
+import type { DeclarationReflection } from "./declaration.js";
 /**
  * @category Reflections
  */