typedoc 0.25.13 → 0.26.0-beta.1

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

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addInferredDeclarationMapPaths = exports.ReflectionSymbolId = void 0;
+exports.ReflectionSymbolId = void 0;
+exports.addInferredDeclarationMapPaths = addInferredDeclarationMapPaths;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const typescript_1 = __importDefault(require("typescript"));
@@ -109,4 +110,3 @@ function addInferredDeclarationMapPaths(opts, files) {
         declarationMapCache.set(mapFile, file);
     }
 }
-exports.addInferredDeclarationMapPaths = addInferredDeclarationMapPaths;

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

@@ -5,6 +5,7 @@ import { ReflectionKind } from "./kind";
 import type { Serializer, Deserializer, JSONOutput } from "../../serialization";
 import type { ReflectionVariant } from "./variant";
 import type { DeclarationReflection } from "./declaration";
+import type { DocumentReflection } from "./document";
 /**
  * Reset the reflection id.
  *
@@ -75,13 +76,14 @@ export declare class ReflectionFlags extends Array<string> {
 }
 export declare enum TraverseProperty {
     Children = 0,
-    Parameters = 1,
-    TypeLiteral = 2,
-    TypeParameter = 3,
-    Signatures = 4,
-    IndexSignature = 5,
-    GetSignature = 6,
-    SetSignature = 7
+    Documents = 1,
+    Parameters = 2,
+    TypeLiteral = 3,
+    TypeParameter = 4,
+    Signatures = 5,
+    IndexSignature = 6,
+    GetSignature = 7,
+    SetSignature = 8
 }
 export interface TraverseCallback {
     /**
@@ -201,6 +203,7 @@ export declare abstract class Reflection {
      */
     isProject(): this is ProjectReflection;
     isDeclaration(): this is DeclarationReflection;
+    isDocument(): this is DocumentReflection;
     /**
      * Check if this reflection or any of its parents have been marked with the `@deprecated` tag.
      */
@@ -209,7 +212,7 @@ export declare abstract class Reflection {
      * Traverse most potential child reflections of this reflection.
      *
      * Note: This may not necessarily traverse child reflections contained within the `type` property
-     * of the reflection, and should not be relied on for this. Support for checking object types will likely be removed in v0.26.
+     * of the reflection, and should not be relied on for this. Support for checking object types will likely be removed in v0.27.
      *
      * The given callback will be invoked for all children, signatures and type parameters
      * attached to this reflection.

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

@@ -34,7 +34,8 @@ 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 = exports.resetReflectionID = void 0;
+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");
@@ -51,7 +52,6 @@ let REFLECTION_ID = 0;
 function resetReflectionID() {
     REFLECTION_ID = 0;
 }
-exports.resetReflectionID = resetReflectionID;
 var ReflectionFlag;
 (function (ReflectionFlag) {
     ReflectionFlag[ReflectionFlag["None"] = 0] = "None";
@@ -221,13 +221,14 @@ ReflectionFlags.serializedFlags = [
 var TraverseProperty;
 (function (TraverseProperty) {
     TraverseProperty[TraverseProperty["Children"] = 0] = "Children";
-    TraverseProperty[TraverseProperty["Parameters"] = 1] = "Parameters";
-    TraverseProperty[TraverseProperty["TypeLiteral"] = 2] = "TypeLiteral";
-    TraverseProperty[TraverseProperty["TypeParameter"] = 3] = "TypeParameter";
-    TraverseProperty[TraverseProperty["Signatures"] = 4] = "Signatures";
-    TraverseProperty[TraverseProperty["IndexSignature"] = 5] = "IndexSignature";
-    TraverseProperty[TraverseProperty["GetSignature"] = 6] = "GetSignature";
-    TraverseProperty[TraverseProperty["SetSignature"] = 7] = "SetSignature";
+    TraverseProperty[TraverseProperty["Documents"] = 1] = "Documents";
+    TraverseProperty[TraverseProperty["Parameters"] = 2] = "Parameters";
+    TraverseProperty[TraverseProperty["TypeLiteral"] = 3] = "TypeLiteral";
+    TraverseProperty[TraverseProperty["TypeParameter"] = 4] = "TypeParameter";
+    TraverseProperty[TraverseProperty["Signatures"] = 5] = "Signatures";
+    TraverseProperty[TraverseProperty["IndexSignature"] = 6] = "IndexSignature";
+    TraverseProperty[TraverseProperty["GetSignature"] = 7] = "GetSignature";
+    TraverseProperty[TraverseProperty["SetSignature"] = 8] = "SetSignature";
 })(TraverseProperty || (exports.TraverseProperty = TraverseProperty = {}));
 /**
  * Base class for all reflection classes.
@@ -275,8 +276,10 @@ let Reflection = (() => {
              * Test whether this reflection is of the given kind.
              */
             kindOf(kind) {
-                const kindArray = Array.isArray(kind) ? kind : [kind];
-                return kindArray.some((kind) => (this.kind & kind) !== 0);
+                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
@@ -396,6 +399,9 @@ let Reflection = (() => {
             isDeclaration() {
                 return false;
             }
+            isDocument() {
+                return false;
+            }
             /**
              * Check if this reflection or any of its parents have been marked with the `@deprecated` tag.
              */

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

@@ -1,17 +1,37 @@
-import { Reflection, TraverseCallback } from "./abstract";
+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";
 /**
  * @category Reflections
  */
 export declare abstract class ContainerReflection extends Reflection {
     /**
-     * The children of this reflection.
+     * The children of this reflection. Do not add reflections to this array
+     * manually. Instead call {@link addChild}.
      */
-    children?: DeclarationReflection[];
+    children?: Array<DeclarationReflection>;
+    /**
+     * Documents associated with this reflection.
+     *
+     * These are not children as including them as children requires code handle both
+     * types, despite being mostly unrelated and handled separately.
+     *
+     * Including them here in a separate array neatly handles that problem, but also
+     * introduces another one for rendering. When rendering, documents should really
+     * actually be considered part of the "children" of a reflection. For this reason,
+     * we also maintain a list of child declarations with child documents which is used
+     * when rendering.
+     */
+    documents?: Array<DocumentReflection>;
+    /**
+     * Union of the {@link children} and {@link documents} arrays which dictates the
+     * sort order for rendering.
+     */
+    childrenIncludingDocuments?: Array<DeclarationReflection | DocumentReflection>;
     /**
      * All children grouped by their kind.
      */
@@ -27,6 +47,8 @@ export declare abstract class ContainerReflection extends Reflection {
      * @returns     An array containing all children with the desired kind.
      */
     getChildrenByKind(kind: ReflectionKind): DeclarationReflection[];
+    addChild(child: DeclarationReflection | DocumentReflection): void;
+    removeChild(child: DeclarationReflection | DocumentReflection): void;
     traverse(callback: TraverseCallback): void;
     toObject(serializer: Serializer): JSONOutput.ContainerReflection;
     fromObject(de: Deserializer, obj: JSONOutput.ContainerReflection): void;

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

@@ -4,6 +4,7 @@ exports.ContainerReflection = void 0;
 const abstract_1 = require("./abstract");
 const ReflectionCategory_1 = require("../ReflectionCategory");
 const ReflectionGroup_1 = require("../ReflectionGroup");
+const utils_1 = require("../../utils");
 /**
  * @category Reflections
  */
@@ -17,17 +18,58 @@ class ContainerReflection extends abstract_1.Reflection {
     getChildrenByKind(kind) {
         return (this.children || []).filter((child) => child.kindOf(kind));
     }
+    addChild(child) {
+        if (child.isDeclaration()) {
+            this.children ||= [];
+            this.children.push(child);
+        }
+        else {
+            this.documents ||= [];
+            this.documents.push(child);
+        }
+        this.childrenIncludingDocuments ||= [];
+        this.childrenIncludingDocuments.push(child);
+    }
+    removeChild(child) {
+        if (child.isDeclaration()) {
+            (0, utils_1.removeIfPresent)(this.children, child);
+            if (this.children?.length === 0) {
+                delete this.children;
+            }
+        }
+        else {
+            (0, utils_1.removeIfPresent)(this.documents, child);
+            if (this.documents?.length === 0) {
+                delete this.documents;
+            }
+        }
+        (0, utils_1.removeIfPresent)(this.childrenIncludingDocuments, child);
+        if (this.childrenIncludingDocuments?.length === 0) {
+            delete this.childrenIncludingDocuments;
+        }
+    }
     traverse(callback) {
         for (const child of this.children?.slice() || []) {
             if (callback(child, abstract_1.TraverseProperty.Children) === false) {
                 return;
             }
         }
+        for (const child of this.documents?.slice() || []) {
+            if (callback(child, abstract_1.TraverseProperty.Documents) === false) {
+                return;
+            }
+        }
     }
     toObject(serializer) {
         return {
             ...super.toObject(serializer),
             children: serializer.toObjectsOptional(this.children),
+            documents: serializer.toObjectsOptional(this.documents),
+            // If we only have one type of child, don't bother writing the duplicate info about
+            // ordering with documents to the serialized file.
+            childrenIncludingDocuments: this.children?.length && this.documents?.length
+                ? this.childrenIncludingDocuments?.map((refl) => refl.id)
+                : undefined,
             groups: serializer.toObjectsOptional(this.groups),
             categories: serializer.toObjectsOptional(this.categories),
         };
@@ -35,6 +77,28 @@ class ContainerReflection extends abstract_1.Reflection {
     fromObject(de, obj) {
         super.fromObject(de, obj);
         this.children = de.reviveMany(obj.children, (child) => de.constructReflection(child));
+        this.documents = de.reviveMany(obj.documents, (child) => de.constructReflection(child));
+        const byId = new Map();
+        for (const child of this.children || []) {
+            byId.set(child.id, child);
+        }
+        for (const child of this.documents || []) {
+            byId.set(child.id, child);
+        }
+        for (const id of obj.childrenIncludingDocuments || []) {
+            const child = byId.get(de.oldIdToNewId[id] ?? -1);
+            if (child) {
+                this.childrenIncludingDocuments ||= [];
+                this.childrenIncludingDocuments.push(child);
+                byId.delete(de.oldIdToNewId[id] ?? -1);
+            }
+        }
+        if (byId.size) {
+            // Anything left in byId wasn't included in the childrenIncludingDocuments array.
+            // This is expected if we're dealing with a JSON file produced by TypeDoc 0.25.
+            this.childrenIncludingDocuments ||= [];
+            this.childrenIncludingDocuments.push(...byId.values());
+        }
         this.groups = de.reviveMany(obj.groups, (group) => new ReflectionGroup_1.ReflectionGroup(group.title, this));
         this.categories = de.reviveMany(obj.categories, (cat) => new ReflectionCategory_1.ReflectionCategory(cat.title));
     }

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

@@ -1,11 +1,11 @@
 import type * as ts from "typescript";
-import { ReferenceType, Type, type SomeType } from "../types";
+import { type ReferenceType, type Type, type SomeType } from "../types";
 import { type TraverseCallback } from "./abstract";
 import { ContainerReflection } from "./container";
 import type { SignatureReflection } from "./signature";
 import type { TypeParameterReflection } from "./type-parameter";
 import type { Serializer, JSONOutput, Deserializer } from "../../serialization";
-import { CommentDisplayPart } from "../comments";
+import { type CommentDisplayPart } from "../comments";
 import { SourceReference } from "../sources/file";
 /**
  * Stores hierarchical type data.
@@ -26,13 +26,6 @@ export interface DeclarationHierarchy {
      */
     isTarget?: boolean;
 }
-/**
- * @internal
- */
-export declare enum ConversionFlags {
-    None = 0,
-    VariableOrPropertySource = 1
-}
 /**
  * A reflection that represents a single declaration emitted by the TypeScript compiler.
  *
@@ -77,7 +70,7 @@ export declare class DeclarationReflection extends ContainerReflection {
     /**
      * The index signature of this declaration.
      */
-    indexSignature?: SignatureReflection;
+    indexSignatures?: SignatureReflection[];
     /**
      * The get signature of this declaration.
      */
@@ -139,11 +132,6 @@ export declare class DeclarationReflection extends ContainerReflection {
      * The version of the module when found.
      */
     packageVersion?: string;
-    /**
-     * Flags for information about a reflection which is needed solely during conversion.
-     * @internal
-     */
-    conversionFlags: ConversionFlags;
     isDeclaration(): this is DeclarationReflection;
     hasGetterOrSetter(): boolean;
     getAllSignatures(): SignatureReflection[];

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeclarationReflection = exports.ConversionFlags = void 0;
+exports.DeclarationReflection = void 0;
 const types_1 = require("../types");
 const abstract_1 = require("./abstract");
 const container_1 = require("./container");
@@ -8,14 +8,6 @@ const comments_1 = require("../comments");
 const file_1 = require("../sources/file");
 const ReflectionSymbolId_1 = require("./ReflectionSymbolId");
 const kind_1 = require("./kind");
-/**
- * @internal
- */
-var ConversionFlags;
-(function (ConversionFlags) {
-    ConversionFlags[ConversionFlags["None"] = 0] = "None";
-    ConversionFlags[ConversionFlags["VariableOrPropertySource"] = 1] = "VariableOrPropertySource";
-})(ConversionFlags || (exports.ConversionFlags = ConversionFlags = {}));
 /**
  * A reflection that represents a single declaration emitted by the TypeScript compiler.
  *
@@ -27,11 +19,6 @@ class DeclarationReflection extends container_1.ContainerReflection {
     constructor() {
         super(...arguments);
         this.variant = "declaration";
-        /**
-         * Flags for information about a reflection which is needed solely during conversion.
-         * @internal
-         */
-        this.conversionFlags = ConversionFlags.None;
     }
     isDeclaration() {
         return true;
@@ -44,8 +31,8 @@ class DeclarationReflection extends container_1.ContainerReflection {
         if (this.signatures) {
             result = result.concat(this.signatures);
         }
-        if (this.indexSignature) {
-            result.push(this.indexSignature);
+        if (this.indexSignatures) {
+            result = result.concat(this.indexSignatures);
         }
         if (this.getSignature) {
             result.push(this.getSignature);
@@ -75,8 +62,8 @@ class DeclarationReflection extends container_1.ContainerReflection {
                 return;
             }
         }
-        if (this.indexSignature) {
-            if (callback(this.indexSignature, abstract_1.TraverseProperty.IndexSignature) === false) {
+        for (const signature of this.indexSignatures?.slice() || []) {
+            if (callback(signature, abstract_1.TraverseProperty.IndexSignature) === false) {
                 return;
             }
         }
@@ -118,7 +105,7 @@ class DeclarationReflection extends container_1.ContainerReflection {
             typeParameters: serializer.toObjectsOptional(this.typeParameters),
             type: serializer.toObject(this.type),
             signatures: serializer.toObjectsOptional(this.signatures),
-            indexSignature: serializer.toObject(this.indexSignature),
+            indexSignatures: serializer.toObjectsOptional(this.indexSignatures),
             getSignature: serializer.toObject(this.getSignature),
             setSignature: serializer.toObject(this.setSignature),
             defaultValue: this.defaultValue,
@@ -149,7 +136,7 @@ class DeclarationReflection extends container_1.ContainerReflection {
                         this.project.registerSymbolId(refl, new ReflectionSymbolId_1.ReflectionSymbolId(sid));
                     }
                     else {
-                        de.logger.warn(`Serialized project contained a reflection with id ${id} but it was not present in deserialized project.`);
+                        de.logger.warn(de.application.i18n.serialized_project_referenced_0_not_part_of_project(id.toString()));
                     }
                 }
             });
@@ -161,7 +148,15 @@ class DeclarationReflection extends container_1.ContainerReflection {
         this.typeParameters = de.reviveMany(obj.typeParameters, (tp) => de.constructReflection(tp));
         this.type = de.revive(obj.type, (t) => de.constructType(t));
         this.signatures = de.reviveMany(obj.signatures, (r) => de.constructReflection(r));
-        this.indexSignature = de.revive(obj.indexSignature, (r) => de.constructReflection(r));
+        // TypeDoc 0.25, remove check with 0.28.
+        if (obj.indexSignature) {
+            this.indexSignatures = [
+                de.revive(obj.indexSignature, (r) => de.constructReflection(r)),
+            ];
+        }
+        else {
+            this.indexSignatures = de.reviveMany(obj.indexSignatures, (r) => de.constructReflection(r));
+        }
         this.getSignature = de.revive(obj.getSignature, (r) => de.constructReflection(r));
         this.setSignature = de.revive(obj.setSignature, (r) => de.constructReflection(r));
         this.defaultValue = obj.defaultValue;

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

@@ -0,0 +1,27 @@
+import type { Deserializer, JSONOutput, Serializer } from "../../serialization";
+import { type CommentDisplayPart } from "../comments";
+import { Reflection, type TraverseCallback } from "./abstract";
+/**
+ * Non-TS reflection type which is used to represent markdown documents included in the docs.
+ */
+export declare class DocumentReflection extends Reflection {
+    readonly variant = "document";
+    /**
+     * The content to be displayed on the page for this reflection.
+     */
+    content: CommentDisplayPart[];
+    /**
+     * Frontmatter included in document
+     */
+    frontmatter: Record<string, unknown>;
+    /**
+     * A precomputed boost derived from the searchCategoryBoosts and searchGroupBoosts options, used when
+     * boosting search relevance scores at runtime. May be modified by plugins.
+     */
+    relevanceBoost?: number;
+    constructor(name: string, parent: Reflection, content: CommentDisplayPart[], frontmatter: Record<string, unknown>);
+    isDocument(): this is DocumentReflection;
+    traverse(_callback: TraverseCallback): void;
+    toObject(serializer: Serializer): JSONOutput.DocumentReflection;
+    fromObject(de: Deserializer, obj: JSONOutput.DocumentReflection): void;
+}

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentReflection = void 0;
+const comments_1 = require("../comments");
+const abstract_1 = require("./abstract");
+const kind_1 = require("./kind");
+/**
+ * Non-TS reflection type which is used to represent markdown documents included in the docs.
+ */
+class DocumentReflection extends abstract_1.Reflection {
+    constructor(name, parent, content, frontmatter) {
+        super(name, kind_1.ReflectionKind.Document, parent);
+        this.variant = "document";
+        this.content = content;
+        this.frontmatter = frontmatter;
+        if (typeof frontmatter["title"] === "string") {
+            this.name = frontmatter["title"];
+            delete frontmatter["title"];
+        }
+    }
+    isDocument() {
+        return true;
+    }
+    traverse(_callback) {
+        // Nothing to do here, we have no children.
+    }
+    toObject(serializer) {
+        return {
+            ...super.toObject(serializer),
+            variant: this.variant,
+            content: comments_1.Comment.serializeDisplayParts(serializer, this.content),
+            frontmatter: this.frontmatter,
+            relevanceBoost: this.relevanceBoost,
+        };
+    }
+    fromObject(de, obj) {
+        super.fromObject(de, obj);
+        this.content = comments_1.Comment.deserializeDisplayParts(de, obj.content);
+        this.frontmatter = obj.frontmatter;
+        this.relevanceBoost = obj.relevanceBoost;
+    }
+}
+exports.DocumentReflection = DocumentReflection;

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

@@ -1,14 +1,15 @@
 export { Reflection, ReflectionFlag, ReflectionFlags, TraverseProperty, } from "./abstract";
-export type { TraverseCallback, ReflectionVisitor } from "./abstract";
+export type { ReflectionVisitor, TraverseCallback } from "./abstract";
 export { ContainerReflection } from "./container";
-export { DeclarationReflection, ConversionFlags } from "./declaration";
+export { DeclarationReflection } from "./declaration";
 export type { DeclarationHierarchy } from "./declaration";
+export { DocumentReflection } from "./document";
 export { ReflectionKind } from "./kind";
 export { ParameterReflection } from "./parameter";
 export { ProjectReflection } from "./project";
 export { ReferenceReflection } from "./reference";
+export { ReflectionSymbolId, type ReflectionSymbolIdString, } from "./ReflectionSymbolId";
 export { SignatureReflection } from "./signature";
 export { TypeParameterReflection, VarianceModifier } from "./type-parameter";
 export { splitUnquotedString } from "./utils";
 export type { ReflectionVariant } from "./variant";
-export { ReflectionSymbolId, type ReflectionSymbolIdString, } from "./ReflectionSymbolId";

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReflectionSymbolId = exports.splitUnquotedString = exports.VarianceModifier = exports.TypeParameterReflection = exports.SignatureReflection = exports.ReferenceReflection = exports.ProjectReflection = exports.ParameterReflection = exports.ReflectionKind = exports.ConversionFlags = exports.DeclarationReflection = exports.ContainerReflection = exports.TraverseProperty = exports.ReflectionFlags = exports.ReflectionFlag = exports.Reflection = void 0;
+exports.splitUnquotedString = exports.VarianceModifier = exports.TypeParameterReflection = exports.SignatureReflection = exports.ReflectionSymbolId = exports.ReferenceReflection = exports.ProjectReflection = exports.ParameterReflection = exports.ReflectionKind = exports.DocumentReflection = exports.DeclarationReflection = exports.ContainerReflection = exports.TraverseProperty = exports.ReflectionFlags = exports.ReflectionFlag = exports.Reflection = void 0;
 var abstract_1 = require("./abstract");
 Object.defineProperty(exports, "Reflection", { enumerable: true, get: function () { return abstract_1.Reflection; } });
 Object.defineProperty(exports, "ReflectionFlag", { enumerable: true, get: function () { return abstract_1.ReflectionFlag; } });
@@ -10,7 +10,8 @@ var container_1 = require("./container");
 Object.defineProperty(exports, "ContainerReflection", { enumerable: true, get: function () { return container_1.ContainerReflection; } });
 var declaration_1 = require("./declaration");
 Object.defineProperty(exports, "DeclarationReflection", { enumerable: true, get: function () { return declaration_1.DeclarationReflection; } });
-Object.defineProperty(exports, "ConversionFlags", { enumerable: true, get: function () { return declaration_1.ConversionFlags; } });
+var document_1 = require("./document");
+Object.defineProperty(exports, "DocumentReflection", { enumerable: true, get: function () { return document_1.DocumentReflection; } });
 var kind_1 = require("./kind");
 Object.defineProperty(exports, "ReflectionKind", { enumerable: true, get: function () { return kind_1.ReflectionKind; } });
 var parameter_1 = require("./parameter");
@@ -19,6 +20,8 @@ var project_1 = require("./project");
 Object.defineProperty(exports, "ProjectReflection", { enumerable: true, get: function () { return project_1.ProjectReflection; } });
 var reference_1 = require("./reference");
 Object.defineProperty(exports, "ReferenceReflection", { enumerable: true, get: function () { return reference_1.ReferenceReflection; } });
+var ReflectionSymbolId_1 = require("./ReflectionSymbolId");
+Object.defineProperty(exports, "ReflectionSymbolId", { enumerable: true, get: function () { return ReflectionSymbolId_1.ReflectionSymbolId; } });
 var signature_1 = require("./signature");
 Object.defineProperty(exports, "SignatureReflection", { enumerable: true, get: function () { return signature_1.SignatureReflection; } });
 var type_parameter_1 = require("./type-parameter");
@@ -26,5 +29,3 @@ Object.defineProperty(exports, "TypeParameterReflection", { enumerable: true, ge
 Object.defineProperty(exports, "VarianceModifier", { enumerable: true, get: function () { return type_parameter_1.VarianceModifier; } });
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "splitUnquotedString", { enumerable: true, get: function () { return utils_1.splitUnquotedString; } });
-var ReflectionSymbolId_1 = require("./ReflectionSymbolId");
-Object.defineProperty(exports, "ReflectionSymbolId", { enumerable: true, get: function () { return ReflectionSymbolId_1.ReflectionSymbolId; } });

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

@@ -26,7 +26,11 @@ export declare enum ReflectionKind {
     GetSignature = 524288,
     SetSignature = 1048576,
     TypeAlias = 2097152,
-    Reference = 4194304
+    Reference = 4194304,
+    /**
+     * Generic non-ts content to be included in the generated docs as its own page.
+     */
+    Document = 8388608
 }
 /** @category Reflections */
 export declare namespace ReflectionKind {
@@ -52,6 +56,7 @@ export declare namespace ReflectionKind {
     const SomeMember: number;
     /** @internal */
     const SomeExport: number;
+    const MayContainDocuments: number;
     /** @internal */
     const ExportContainer: number;
     /** @internal */
@@ -67,9 +72,17 @@ export declare namespace ReflectionKind {
      * @internal
      */
     const SignatureContainer: number;
+    /** @internal */
     const VariableContainer: number;
+    /** @internal */
     const MethodContainer: number;
+    /**
+     * Get a non-localized kind string. For the localized string, use `app.internationalization.kindSingularString(kind)`
+     */
     function singularString(kind: ReflectionKind): string;
+    /**
+     * Get a non-localized kind string. For the localized string, use `app.internationalization.kindPluralString(kind)`
+     */
     function pluralString(kind: ReflectionKind): string;
     function classString(kind: ReflectionKind): string;
 }

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

@@ -30,6 +30,10 @@ var ReflectionKind;
     ReflectionKind[ReflectionKind["SetSignature"] = 1048576] = "SetSignature";
     ReflectionKind[ReflectionKind["TypeAlias"] = 2097152] = "TypeAlias";
     ReflectionKind[ReflectionKind["Reference"] = 4194304] = "Reference";
+    /**
+     * Generic non-ts content to be included in the generated docs as its own page.
+     */
+    ReflectionKind[ReflectionKind["Document"] = 8388608] = "Document";
 })(ReflectionKind || (exports.ReflectionKind = ReflectionKind = {}));
 /** @category Reflections */
 (function (ReflectionKind) {
@@ -75,6 +79,7 @@ var ReflectionKind;
         ReflectionKind.Interface |
         ReflectionKind.TypeAlias |
         ReflectionKind.Reference;
+    ReflectionKind.MayContainDocuments = ReflectionKind.SomeExport | ReflectionKind.Project;
     /** @internal */
     ReflectionKind.ExportContainer = ReflectionKind.SomeModule | ReflectionKind.Project;
     /** @internal */
@@ -104,7 +109,9 @@ var ReflectionKind;
      * @internal
      */
     ReflectionKind.SignatureContainer = ReflectionKind.ContainsCallSignatures | ReflectionKind.Accessor;
+    /** @internal */
     ReflectionKind.VariableContainer = ReflectionKind.SomeModule | ReflectionKind.Project;
+    /** @internal */
     ReflectionKind.MethodContainer = ReflectionKind.ClassOrInterface |
         ReflectionKind.VariableOrProperty |
         ReflectionKind.FunctionOrMethod |
@@ -120,6 +127,9 @@ var ReflectionKind;
         [ReflectionKind.EnumMember]: "Enumeration Members",
         [ReflectionKind.TypeAlias]: "Type Aliases",
     };
+    /**
+     * Get a non-localized kind string. For the localized string, use `app.internationalization.kindSingularString(kind)`
+     */
     function singularString(kind) {
         if (kind in SINGULARS) {
             return SINGULARS[kind];
@@ -129,6 +139,9 @@ var ReflectionKind;
         }
     }
     ReflectionKind.singularString = singularString;
+    /**
+     * Get a non-localized kind string. For the localized string, use `app.internationalization.kindPluralString(kind)`
+     */
     function pluralString(kind) {
         if (kind in PLURALS) {
             return PLURALS[kind];

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

@@ -1,5 +1,5 @@
 import type { SomeType } from "..";
-import { Reflection, TraverseCallback } from "./abstract";
+import { Reflection, type TraverseCallback } from "./abstract";
 import type { SignatureReflection } from "./signature";
 import type { Serializer, JSONOutput, Deserializer } from "../../serialization";
 /**

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

@@ -1,8 +1,8 @@
-import { Reflection } from "./abstract";
+import { type Reflection } from "./abstract";
 import { ContainerReflection } from "./container";
 import type * as ts from "typescript";
 import { ReflectionKind } from "./kind";
-import { CommentDisplayPart } from "../comments";
+import { type CommentDisplayPart } from "../comments";
 import { ReflectionSymbolId } from "./ReflectionSymbolId";
 import type { Serializer } from "../../serialization/serializer";
 import type { Deserializer, JSONOutput } from "../../serialization/index";