typedoc 0.23.20 → 0.23.22

package/dist/lib/converter/comments/declarationReference.d.ts

@@ -6,7 +6,7 @@
  * @module
  */
 export declare const MeaningKeywords: readonly ["class", "interface", "type", "enum", "namespace", "function", "var", "constructor", "member", "event", "call", "new", "index", "complex", "getter", "setter"];
-export declare type MeaningKeyword = typeof MeaningKeywords[number];
+export type MeaningKeyword = typeof MeaningKeywords[number];
 export interface DeclarationReference {
     resolutionStart: "global" | "local";
     moduleSource?: string;

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

@@ -54,7 +54,7 @@ const wantedKinds = {
         ts.SyntaxKind.PropertySignature,
         ts.SyntaxKind.BinaryExpression,
         ts.SyntaxKind.PropertyAssignment,
-        // class X { constructor(/** Comment */ readonly z: any) }
+        // class X { constructor(/** Comment */ readonly z: string) }
         ts.SyntaxKind.Parameter,
     ],
     [models_1.ReflectionKind.Method]: [
@@ -75,7 +75,7 @@ const wantedKinds = {
     [models_1.ReflectionKind.Parameter]: [ts.SyntaxKind.Parameter],
     [models_1.ReflectionKind.TypeLiteral]: [ts.SyntaxKind.TypeLiteral],
     [models_1.ReflectionKind.TypeParameter]: [ts.SyntaxKind.TypeParameter],
-    [models_1.ReflectionKind.Accessor]: [],
+    [models_1.ReflectionKind.Accessor]: [ts.SyntaxKind.PropertyDeclaration],
     [models_1.ReflectionKind.GetSignature]: [ts.SyntaxKind.GetAccessor],
     [models_1.ReflectionKind.SetSignature]: [ts.SyntaxKind.SetAccessor],
     [models_1.ReflectionKind.ObjectLiteral]: [ts.SyntaxKind.ObjectLiteralExpression],

package/dist/lib/converter/context.js

@@ -12,21 +12,6 @@ const comments_1 = require("./comments");
  * The context describes the current state the converter is in.
  */
 class Context {
-    /**
-     * Create a new Context instance.
-     *
-     * @param converter  The converter instance that has created the context.
-     * @internal
-     */
-    constructor(converter, programs, project, scope = project) {
-        /** @internal */
-        this.shouldBeStatic = false;
-        this.convertingTypeNode = false;
-        this.converter = converter;
-        this.programs = programs;
-        this.project = project;
-        this.scope = scope;
-    }
     /**
      * The TypeChecker instance returned by the TypeScript compiler.
      */
@@ -49,6 +34,21 @@ class Context {
     setConvertingTypeNode() {
         this.convertingTypeNode = true;
     }
+    /**
+     * Create a new Context instance.
+     *
+     * @param converter  The converter instance that has created the context.
+     * @internal
+     */
+    constructor(converter, programs, project, scope = project) {
+        /** @internal */
+        this.shouldBeStatic = false;
+        this.convertingTypeNode = false;
+        this.converter = converter;
+        this.programs = programs;
+        this.project = project;
+        this.scope = scope;
+    }
     /** @internal */
     get logger() {
         return this.converter.application.logger;

package/dist/lib/converter/converter.js

@@ -27,6 +27,9 @@ const linkResolver_1 = require("./comments/linkResolver");
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  */
 let Converter = Converter_1 = class Converter extends component_1.ChildableComponent {
+    get config() {
+        return this._config || this._buildCommentParserConfig();
+    }
     constructor(owner) {
         super(owner);
         this._externalSymbolResolvers = [];
@@ -50,11 +53,11 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
             if (typeof modLinks[name] === "string") {
                 return modLinks[name];
             }
+            if (typeof modLinks["*"] === "string") {
+                return modLinks["*"];
+            }
         });
     }
-    get config() {
-        return this._config || this._buildCommentParserConfig();
-    }
     /**
      * Compile the given source files and create a project reflection for them.
      */

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

@@ -2,11 +2,13 @@ import { ConverterComponent } from "../components";
 /**
  * Handles most behavior triggered by comments. `@group` and `@category` are handled by their respective plugins, but everything else is here.
  *
+ * How it works today
+ * ==================
  * During conversion:
  * - Handle visibility flags (`@private`, `@protected`. `@public`)
  * - Handle module renames (`@module`)
  * - Remove excluded tags & comment discovery tags (`@module`, `@packageDocumentation`)
- * - Copy comments for type parameters from the parent container
+ * - Copy comments for type parameters from the parent container (for classes/interfaces)
  *
  * Resolve begin:
  * - Remove hidden reflections
@@ -15,13 +17,43 @@ import { ConverterComponent } from "../components";
  * - Apply `@label` tag
  * - Copy comments on signature containers to the signature if signatures don't already have a comment
  *   and then remove the comment on the container.
- * - Copy comments from signatures to parameters and type parameters (again? why?)
+ * - Copy comments to parameters and type parameters (for signatures)
  * - Apply `@group` and `@category` tags
  *
  * Resolve end:
  * - Copy auto inherited comments from heritage clauses
  * - Handle `@inheritDoc`
  * - Resolve `@link` tags to point to target reflections
+ *
+ * How it should work
+ * ==================
+ * During conversion:
+ * - Handle visibility flags (`@private`, `@protected`. `@public`)
+ * - Handle module renames (`@module`)
+ * - Remove excluded tags & comment discovery tags (`@module`, `@packageDocumentation`)
+ *
+ * Resolve begin (100):
+ * - Copy auto inherited comments from heritage clauses
+ * - Apply `@label` tag
+ *
+ * Resolve begin (75)
+ * - Handle `@inheritDoc`
+ *
+ * Resolve begin (50)
+ * - Copy comments on signature containers to the signature if signatures don't already have a comment
+ *   and then remove the comment on the container.
+ * - Copy comments for type parameters from the parent container (for classes/interfaces)
+ *
+ * Resolve begin (25)
+ * - Remove hidden reflections
+ *
+ * Resolve:
+ * - Copy comments to parameters and type parameters (for signatures)
+ * - Apply `@group` and `@category` tags
+ *
+ * Resolve end:
+ * - Resolve `@link` tags to point to target reflections
+ *
  */
 export declare class CommentPlugin extends ConverterComponent {
     excludeTags: `@${string}`[];

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

@@ -35,11 +35,13 @@ const NEVER_RENDERED = [
 /**
  * Handles most behavior triggered by comments. `@group` and `@category` are handled by their respective plugins, but everything else is here.
  *
+ * How it works today
+ * ==================
  * During conversion:
  * - Handle visibility flags (`@private`, `@protected`. `@public`)
  * - Handle module renames (`@module`)
  * - Remove excluded tags & comment discovery tags (`@module`, `@packageDocumentation`)
- * - Copy comments for type parameters from the parent container
+ * - Copy comments for type parameters from the parent container (for classes/interfaces)
  *
  * Resolve begin:
  * - Remove hidden reflections
@@ -48,13 +50,43 @@ const NEVER_RENDERED = [
  * - Apply `@label` tag
  * - Copy comments on signature containers to the signature if signatures don't already have a comment
  *   and then remove the comment on the container.
- * - Copy comments from signatures to parameters and type parameters (again? why?)
+ * - Copy comments to parameters and type parameters (for signatures)
  * - Apply `@group` and `@category` tags
  *
  * Resolve end:
  * - Copy auto inherited comments from heritage clauses
  * - Handle `@inheritDoc`
  * - Resolve `@link` tags to point to target reflections
+ *
+ * How it should work
+ * ==================
+ * During conversion:
+ * - Handle visibility flags (`@private`, `@protected`. `@public`)
+ * - Handle module renames (`@module`)
+ * - Remove excluded tags & comment discovery tags (`@module`, `@packageDocumentation`)
+ *
+ * Resolve begin (100):
+ * - Copy auto inherited comments from heritage clauses
+ * - Apply `@label` tag
+ *
+ * Resolve begin (75)
+ * - Handle `@inheritDoc`
+ *
+ * Resolve begin (50)
+ * - Copy comments on signature containers to the signature if signatures don't already have a comment
+ *   and then remove the comment on the container.
+ * - Copy comments for type parameters from the parent container (for classes/interfaces)
+ *
+ * Resolve begin (25)
+ * - Remove hidden reflections
+ *
+ * Resolve:
+ * - Copy comments to parameters and type parameters (for signatures)
+ * - Apply `@group` and `@category` tags
+ *
+ * Resolve end:
+ * - Resolve `@link` tags to point to target reflections
+ *
  */
 let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent {
     /**

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

@@ -1,7 +1,6 @@
 import { ReflectionKind, DeclarationReflection } from "../../models/reflections/index";
 import { ReflectionGroup } from "../../models/ReflectionGroup";
 import { ConverterComponent } from "../components";
-import { SortStrategy } from "../../utils/sort";
 /**
  * A handler that sorts and groups the found reflections in the resolving phase.
  *
@@ -25,8 +24,7 @@ export declare class GroupPlugin extends ConverterComponent {
         16: string;
         4194304: string;
     };
-    /** @internal */
-    sortStrategies: SortStrategy[];
+    sortFunction: (reflections: DeclarationReflection[]) => void;
     boosts: Record<string, number>;
     usedBoosts: Set<string>;
     /**

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

@@ -30,6 +30,9 @@ let GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.Convert
      */
     initialize() {
         this.listenTo(this.owner, {
+            [converter_1.Converter.EVENT_RESOLVE_BEGIN]: () => {
+                this.sortFunction = (0, sort_1.getSortFunction)(this.application.options);
+            },
             [converter_1.Converter.EVENT_RESOLVE]: this.onResolve,
             [converter_1.Converter.EVENT_RESOLVE_END]: this.onEndResolve,
         });
@@ -68,7 +71,7 @@ let GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.Convert
         if (reflection.children &&
             reflection.children.length > 0 &&
             !reflection.groups) {
-            (0, sort_1.sortReflections)(reflection.children, this.sortStrategies);
+            this.sortFunction(reflection.children);
             reflection.groups = this.getReflectionGroups(reflection.children);
         }
     }
@@ -193,9 +196,6 @@ GroupPlugin.PLURALS = {
     [index_1.ReflectionKind.EnumMember]: "Enumeration Members",
     [index_1.ReflectionKind.TypeAlias]: "Type Aliases",
 };
-__decorate([
-    (0, utils_1.BindOption)("sort")
-], GroupPlugin.prototype, "sortStrategies", void 0);
 __decorate([
     (0, utils_1.BindOption)("searchGroupBoosts")
 ], GroupPlugin.prototype, "boosts", void 0);

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

@@ -16,6 +16,7 @@ const fs_1 = require("../../utils/fs");
 const path_1 = require("path");
 const models_1 = require("../../models");
 const repository_1 = require("../utils/repository");
+const base_path_1 = require("../utils/base-path");
 /**
  * A handler that attaches source file information to reflections.
  */
@@ -64,7 +65,7 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
         const symbol = reflection.project.getSymbolFromReflection(reflection);
         for (const node of symbol?.declarations || []) {
             const sourceFile = node.getSourceFile();
-            const fileName = sourceFile.fileName;
+            const fileName = base_path_1.BasePath.normalize(sourceFile.fileName);
             this.fileNames.add(fileName);
             let position;
             if ((0, nodes_1.isNamedNode)(node)) {
@@ -81,7 +82,7 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
         if (this.disableSources || !sig)
             return;
         const sourceFile = sig.getSourceFile();
-        const fileName = sourceFile.fileName;
+        const fileName = base_path_1.BasePath.normalize(sourceFile.fileName);
         this.fileNames.add(fileName);
         const position = ts.getLineAndCharacterOfPosition(sourceFile, sig.getStart());
         reflection.sources || (reflection.sources = []);

package/dist/lib/converter/utils/base-path.js

@@ -82,7 +82,7 @@ class BasePath {
         path = path.replace(/\\/g, "/");
         // Remove all surrounding quotes
         path = path.replace(/^["']+|["']+$/g, "");
-        // Make Windows drive letters lower case
+        // Make Windows drive letters upper case
         return path.replace(/^([^:]+):\//, (_m, m1) => m1.toUpperCase() + ":/");
     }
 }

package/dist/lib/models/comments/comment.d.ts

@@ -1,6 +1,6 @@
 import type { Reflection } from "../reflections";
 import type { Serializer, JSONOutput } from "../../serialization";
-export declare type CommentDisplayPart = {
+export type CommentDisplayPart = {
     kind: "text";
     text: string;
 } | {

package/dist/lib/models/comments/comment.js

@@ -53,22 +53,6 @@ exports.CommentTag = CommentTag;
  * through the {@link DeclarationReflection.comment} property.
  */
 class Comment {
-    /**
-     * Creates a new Comment instance.
-     */
-    constructor(summary = [], blockTags = [], modifierTags = new Set()) {
-        /**
-         * All associated block level tags.
-         */
-        this.blockTags = [];
-        /**
-         * All modifier tags present on the comment, e.g. `@alpha`, `@beta`.
-         */
-        this.modifierTags = new Set();
-        this.summary = summary;
-        this.blockTags = blockTags;
-        this.modifierTags = modifierTags;
-    }
     /**
      * Debugging utility for combining parts into a simple string. Not suitable for
      * rendering, but can be useful in tests.
@@ -96,6 +80,22 @@ class Comment {
     static cloneDisplayParts(parts) {
         return parts.map((p) => ({ ...p }));
     }
+    /**
+     * Creates a new Comment instance.
+     */
+    constructor(summary = [], blockTags = [], modifierTags = new Set()) {
+        /**
+         * All associated block level tags.
+         */
+        this.blockTags = [];
+        /**
+         * All modifier tags present on the comment, e.g. `@alpha`, `@beta`.
+         */
+        this.modifierTags = new Set();
+        this.summary = summary;
+        this.blockTags = blockTags;
+        this.modifierTags = modifierTags;
+    }
     /**
      * Create a deep clone of this comment.
      */

package/dist/lib/models/reflections/abstract.js

@@ -209,6 +209,12 @@ var TraverseProperty;
  * contains a list of all children grouped and sorted for rendering.
  */
 class Reflection {
+    get project() {
+        if (this.isProject())
+            return this;
+        (0, assert_1.ok)(this.parent, "Tried to get the project on a reflection not in a project");
+        return this.parent.project;
+    }
     constructor(name, kind, parent) {
         this.flags = new ReflectionFlags();
         this.id = REFLECTION_ID++;
@@ -221,12 +227,6 @@ class Reflection {
             this.setFlag(ReflectionFlag.External);
         }
     }
-    get project() {
-        if (this.isProject())
-            return this;
-        (0, assert_1.ok)(this.parent, "Tried to get the project on a reflection not in a project");
-        return this.parent.project;
-    }
     /**
      * Test whether this reflection is of the given kind.
      */

package/dist/lib/models/reflections/type-parameter.d.ts

@@ -11,7 +11,7 @@ export declare const VarianceModifier: {
     readonly out: "out";
     readonly inOut: "in out";
 };
-export declare type VarianceModifier = typeof VarianceModifier[keyof typeof VarianceModifier];
+export type VarianceModifier = typeof VarianceModifier[keyof typeof VarianceModifier];
 export declare class TypeParameterReflection extends Reflection {
     parent?: DeclarationReflection;
     type?: SomeType;

package/dist/lib/models/types.d.ts

@@ -53,12 +53,12 @@ export interface TypeKindMap {
     union: UnionType;
     unknown: UnknownType;
 }
-export declare type TypeVisitor<T = void> = {
+export type TypeVisitor<T = void> = {
     [K in TypeKind]: (type: TypeKindMap[K]) => T;
 };
 export declare function makeRecursiveVisitor(visitor: Partial<TypeVisitor>): TypeVisitor;
-export declare type TypeKind = keyof TypeKindMap;
-export declare type SomeType = TypeKindMap[keyof TypeKindMap];
+export type TypeKind = keyof TypeKindMap;
+export type SomeType = TypeKindMap[keyof TypeKindMap];
 /**
  * Enumeration that can be used when traversing types to track the location of recursion.
  * Used by TypeDoc internally to track when to output parenthesis when rendering.
@@ -89,7 +89,7 @@ export declare const TypeContext: {
     readonly tupleElement: "tupleElement";
     readonly unionElement: "unionElement";
 };
-export declare type TypeContext = typeof TypeContext[keyof typeof TypeContext];
+export type TypeContext = typeof TypeContext[keyof typeof TypeContext];
 /**
  * Represents an array type.
  *
@@ -242,7 +242,7 @@ export declare class OptionalType extends Type {
  * Represents a type predicate.
  *
  * ```ts
- * function isString(anything: any): anything is string {}
+ * function isString(x: unknown): x is string {}
  * function assert(condition: boolean): asserts condition {}
  * ```
  */

package/dist/lib/models/types.js

@@ -543,7 +543,7 @@ exports.OptionalType = OptionalType;
  * Represents a type predicate.
  *
  * ```ts
- * function isString(anything: any): anything is string {}
+ * function isString(x: unknown): x is string {}
  * function assert(condition: boolean): asserts condition {}
  * ```
  */
@@ -629,14 +629,6 @@ exports.QueryType = QueryType;
  * ```
  */
 class ReferenceType extends Type {
-    constructor(name, target, project, qualifiedName) {
-        super();
-        this.type = "reference";
-        this.name = name;
-        this._target = target instanceof abstract_1.Reflection ? target.id : target;
-        this._project = project;
-        this.qualifiedName = qualifiedName;
-    }
     /**
      * The resolved reflection.
      */
@@ -675,6 +667,14 @@ class ReferenceType extends Type {
             },
         };
     }
+    constructor(name, target, project, qualifiedName) {
+        super();
+        this.type = "reference";
+        this.name = name;
+        this._target = target instanceof abstract_1.Reflection ? target.id : target;
+        this._project = project;
+        this.qualifiedName = qualifiedName;
+    }
     static createResolvedReference(name, target, project) {
         return new ReferenceType(name, target, project, name);
     }

package/dist/lib/output/events.js

@@ -86,6 +86,13 @@ MarkdownEvent.PARSE = "parseMarkdown";
  * An event emitted when the search index is being prepared.
  */
 class IndexEvent extends events_1.Event {
+    /**
+     * Remove a search result by index.
+     */
+    removeResult(index) {
+        this.searchResults.splice(index, 1);
+        this.searchFields.splice(index, 1);
+    }
     constructor(name, searchResults) {
         super(name);
         /**
@@ -105,13 +112,6 @@ class IndexEvent extends events_1.Event {
         this.searchResults = searchResults;
         this.searchFields = Array.from({ length: this.searchResults.length }, () => ({}));
     }
-    /**
-     * Remove a search result by index.
-     */
-    removeResult(index) {
-        this.searchResults.splice(index, 1);
-        this.searchFields.splice(index, 1);
-    }
 }
 exports.IndexEvent = IndexEvent;
 /**

package/dist/lib/output/models/UrlMapping.d.ts

@@ -6,4 +6,4 @@ export declare class UrlMapping<Model = any> {
     template: RenderTemplate<PageEvent<Model>>;
     constructor(url: string, model: Model, template: RenderTemplate<PageEvent<Model>>);
 }
-export declare type RenderTemplate<T> = (data: T) => JSX.Element | string;
+export type RenderTemplate<T> = (data: T) => JSX.Element | string;

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

@@ -12,6 +12,12 @@ const utils_1 = require("../../../utils");
  * {@link Theme} implementation, this theme class will be used.
  */
 class DefaultTheme extends theme_1.Theme {
+    getRenderContext(_pageEvent) {
+        if (!this._renderContext) {
+            this._renderContext = new DefaultThemeRenderContext_1.DefaultThemeRenderContext(this, this.application.options);
+        }
+        return this._renderContext;
+    }
     /**
      * Create a new DefaultTheme instance.
      *
@@ -72,12 +78,6 @@ class DefaultTheme extends theme_1.Theme {
         this.markedPlugin = renderer.getComponent("marked");
         this.listenTo(renderer, events_1.RendererEvent.BEGIN, this.onRendererBegin, 1024);
     }
-    getRenderContext(_pageEvent) {
-        if (!this._renderContext) {
-            this._renderContext = new DefaultThemeRenderContext_1.DefaultThemeRenderContext(this, this.application.options);
-        }
-        return this._renderContext;
-    }
     /**
      * Map the models of the given project to the desired output files.
      *

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

@@ -100,8 +100,8 @@ function displayPartsToMarkdown(parts, urlTo) {
                     case "@linkplain": {
                         if (part.target) {
                             const url = typeof part.target === "string" ? part.target : urlTo(part.target);
-                            const wrap = part.tag === "@linkcode" ? "`" : "";
-                            result.push(url ? `[${wrap}${part.text}${wrap}](${url})` : part.text);
+                            const text = part.tag === "@linkcode" ? `<code>${part.text}</code>` : part.text;
+                            result.push(url ? `<a href="${url}">${text}</a>` : part.text);
                         }
                         else {
                             result.push(part.text);

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

@@ -31,10 +31,10 @@ import type * as M from "../models";
 /**
  * Describes the mapping from Model types to the corresponding JSON output type.
  */
-export declare type ModelToObject<T> = T extends Array<infer U> ? _ModelToObject<U>[] : _ModelToObject<T>;
-declare type _ModelToObject<T> = T extends Primitive ? T : T extends M.ReflectionGroup ? ReflectionGroup : T extends M.ReflectionCategory ? ReflectionCategory : T extends M.SignatureReflection ? SignatureReflection : T extends M.ParameterReflection ? ParameterReflection : T extends M.DeclarationReflection ? DeclarationReflection : T extends M.TypeParameterReflection ? TypeParameterReflection : T extends M.ProjectReflection ? ProjectReflection : T extends M.ContainerReflection ? ContainerReflection : T extends M.ReferenceReflection ? ReferenceReflection : T extends M.Reflection ? Reflection : T extends M.SomeType ? TypeKindMap[T["type"]] : T extends M.Type ? SomeType : T extends M.Comment ? Comment : T extends M.CommentTag ? CommentTag : T extends M.CommentDisplayPart ? CommentDisplayPart : T extends M.SourceReference ? SourceReference : never;
-declare type Primitive = string | number | undefined | null | boolean;
-declare type ToSerialized<T> = T extends Primitive ? T : T extends bigint ? {
+export type ModelToObject<T> = T extends Array<infer U> ? _ModelToObject<U>[] : _ModelToObject<T>;
+type _ModelToObject<T> = T extends Primitive ? T : T extends M.ReflectionGroup ? ReflectionGroup : T extends M.ReflectionCategory ? ReflectionCategory : T extends M.SignatureReflection ? SignatureReflection : T extends M.ParameterReflection ? ParameterReflection : T extends M.DeclarationReflection ? DeclarationReflection : T extends M.TypeParameterReflection ? TypeParameterReflection : T extends M.ProjectReflection ? ProjectReflection : T extends M.ContainerReflection ? ContainerReflection : T extends M.ReferenceReflection ? ReferenceReflection : T extends M.Reflection ? Reflection : T extends M.SomeType ? TypeKindMap[T["type"]] : T extends M.Type ? SomeType : T extends M.Comment ? Comment : T extends M.CommentTag ? CommentTag : T extends M.CommentDisplayPart ? CommentDisplayPart : T extends M.SourceReference ? SourceReference : never;
+type Primitive = string | number | undefined | null | boolean;
+type ToSerialized<T> = T extends Primitive ? T : T extends bigint ? {
     value: string;
     negative: boolean;
 } : ModelToObject<T>;
@@ -44,7 +44,7 @@ declare type ToSerialized<T> = T extends Primitive ? T : T extends bigint ? {
  * This helper removes the readonly modifier from properties since the result of serialization
  * is a plain object that consumers may modify as they choose, TypeDoc doesn't care.
  */
-declare type S<T, K extends keyof T> = {
+type S<T, K extends keyof T> = {
     -readonly [K2 in K]: ToSerialized<T[K2]>;
 };
 export interface ReflectionGroup extends S<M.ReflectionGroup, "title" | "categories"> {
@@ -78,8 +78,8 @@ export interface Reflection extends S<M.Reflection, "id" | "name" | "kind" | "ki
     originalName?: M.Reflection["originalName"];
     flags: ReflectionFlags;
 }
-export declare type SomeType = ModelToObject<M.SomeType>;
-export declare type TypeKindMap = {
+export type SomeType = ModelToObject<M.SomeType>;
+export type TypeKindMap = {
     array: ArrayType;
     conditional: ConditionalType;
     indexedAccess: IndexedAccessType;
@@ -148,7 +148,7 @@ export interface UnknownType extends Type, S<M.UnknownType, "type" | "name"> {
 }
 export interface Type {
 }
-declare type BoolKeys<T> = {
+type BoolKeys<T> = {
     [K in keyof T]-?: T[K] extends boolean ? K : never;
 }[keyof T];
 export interface ReflectionFlags extends Partial<S<M.ReflectionFlags, BoolKeys<M.ReflectionFlags>>> {
@@ -164,7 +164,7 @@ export interface CommentTag extends S<M.CommentTag, "tag" | "name"> {
  * If `target` is a number, it is a reflection ID. If a string, it is a URL.
  * `target` will only be set for `@link`, `@linkcode`, and `@linkplain` tags.
  */
-export declare type CommentDisplayPart = {
+export type CommentDisplayPart = {
     kind: "text";
     text: string;
 } | {

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

@@ -22,7 +22,7 @@ export declare const EntryPointStrategy: {
      */
     readonly Packages: "packages";
 };
-export declare type EntryPointStrategy = typeof EntryPointStrategy[keyof typeof EntryPointStrategy];
+export type EntryPointStrategy = typeof EntryPointStrategy[keyof typeof EntryPointStrategy];
 export interface DocumentationEntryPoint {
     displayName: string;
     readmeFile?: string;

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

@@ -2,3 +2,4 @@ export declare function getEnumFlags<T extends number>(flags: T): T[];
 export declare function removeFlag<T extends number>(flag: T, remove: T & {}): T;
 export declare function hasAllFlags(flags: number, check: number): boolean;
 export declare function hasAnyFlag(flags: number, check: number): boolean;
+export declare function getEnumKeys(Enum: Record<string, string | number>): string[];

package/dist/lib/utils/enum.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasAnyFlag = exports.hasAllFlags = exports.removeFlag = exports.getEnumFlags = void 0;
+exports.getEnumKeys = exports.hasAnyFlag = exports.hasAllFlags = exports.removeFlag = exports.getEnumFlags = void 0;
 function getEnumFlags(flags) {
     const result = [];
     for (let i = 1; i <= flags; i <<= 1) {
@@ -24,3 +24,10 @@ function hasAnyFlag(flags, check) {
     return (flags & check) !== 0;
 }
 exports.hasAnyFlag = hasAnyFlag;
+// Note: String enums are not handled.
+function getEnumKeys(Enum) {
+    return Object.keys(Enum).filter((k) => {
+        return Enum[Enum[k]] === k;
+    });
+}
+exports.getEnumKeys = getEnumKeys;

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

@@ -4,7 +4,7 @@
  * script will be used to switch this flag to false when publishing, then immediately back
  * to true after a successful publish.
  */
-declare type InternalOnly = false;
+type InternalOnly = false;
 /**
  * Helper type to convert `T` to `F` if strict mode is on.
  *
@@ -23,17 +23,17 @@ declare type InternalOnly = false;
  * function over(flag: string): string { return flag }
  * ```
  */
-export declare type IfInternal<T, F> = InternalOnly extends true ? T : F;
+export type IfInternal<T, F> = InternalOnly extends true ? T : F;
 /**
  * Helper type to convert `T` to `never` if strict mode is on.
  *
  * See {@link IfInternal} for the rationale.
  */
-export declare type NeverIfInternal<T> = IfInternal<never, T>;
+export type NeverIfInternal<T> = IfInternal<never, T>;
 /**
  * Resolves a string type into a union of characters, `"ab"` turns into `"a" | "b"`.
  */
-export declare type Chars<T extends string> = T extends `${infer C}${infer R}` ? C | Chars<R> : never;
+export type Chars<T extends string> = T extends `${infer C}${infer R}` ? C | Chars<R> : never;
 /**
  * Utility to help type checking ensure that there is no uncovered case.
  */