Update categories/groups to contain DeclarationReflection

This type is more accurate, and lets us get rid of an inappropriate assert.

Author: Gerrit0

src/lib/converter/plugins/CategoryPlugin.ts

@@ -135,7 +135,7 @@ export class CategoryPlugin extends ConverterComponent {
      * @returns An array containing all children of the given reflection categorized
      */
     static getReflectionCategories(
-        reflections: Reflection[]
+        reflections: DeclarationReflection[]
     ): ReflectionCategory[] {
         const categories: ReflectionCategory[] = [];
         let defaultCat: ReflectionCategory | undefined;

src/lib/converter/plugins/GroupPlugin.ts

@@ -112,7 +112,9 @@ export class GroupPlugin extends ConverterComponent {
      * @param reflections  The reflections that should be grouped.
      * @returns An array containing all children of the given reflection grouped by their kind.
      */
-    static getReflectionGroups(reflections: Reflection[]): ReflectionGroup[] {
+    static getReflectionGroups(
+        reflections: DeclarationReflection[]
+    ): ReflectionGroup[] {
         const groups: ReflectionGroup[] = [];
         reflections.forEach((child) => {
             for (let i = 0; i < groups.length; i++) {

src/lib/converter/plugins/SourcePlugin.ts

@@ -158,7 +158,7 @@ export class SourcePlugin extends ConverterComponent {
         const project = context.project;
         const home = project.directory;
         project.files.forEach((file) => {
-            const reflections: Reflection[] = [];
+            const reflections: DeclarationReflection[] = [];
             file.reflections.forEach((reflection) => {
                 reflections.push(reflection);
             });
@@ -183,7 +183,6 @@ export class SourcePlugin extends ConverterComponent {
             }
 
             directory.files.push(file);
-            // reflections.sort(GroupHandler.sortCallback);
             file.parent = directory;
             file.reflections = reflections;
         });

src/lib/models/ReflectionCategory.ts

@@ -1,4 +1,4 @@
-import type { Reflection } from "./reflections/abstract";
+import type { DeclarationReflection } from ".";
 
 /**
  * A category of reflections.
@@ -16,7 +16,7 @@ export class ReflectionCategory {
     /**
      * All reflections of this category.
      */
-    children: Reflection[] = [];
+    children: DeclarationReflection[] = [];
 
     /**
      * Create a new ReflectionCategory instance.

src/lib/models/ReflectionGroup.ts

@@ -1,5 +1,6 @@
-import type { Reflection, ReflectionKind } from "./reflections/abstract";
+import type { ReflectionKind } from "./reflections/abstract";
 import type { ReflectionCategory } from "./ReflectionCategory";
+import type { DeclarationReflection } from ".";
 
 /**
  * A group of reflections. All reflections in a group are of the same kind.
@@ -22,7 +23,7 @@ export class ReflectionGroup {
     /**
      * All reflections of this group.
      */
-    children: Reflection[] = [];
+    children: DeclarationReflection[] = [];
 
     /**
      * A list of generated css classes that should be applied to representations of this

src/lib/models/sources/directory.ts

@@ -1,6 +1,7 @@
-import type { Reflection } from "../reflections/abstract";
 import type { ReflectionGroup } from "../ReflectionGroup";
 import type { SourceFile } from "./file";
+import type { DeclarationReflection } from "..";
+import { flatMap } from "../../utils/array";
 
 /**
  * Exposes information about a directory containing source files.
@@ -82,13 +83,7 @@ export class SourceDirectory {
      * @returns An aggregated list of all {@link DeclarationReflection} defined in the
      * files of this directory.
      */
-    getAllReflections(): Reflection[] {
-        const reflections: Reflection[] = [];
-        this.files.forEach((file) => {
-            reflections.push(...file.reflections);
-        });
-
-        // reflections.sort(Factories.GroupHandler.sortCallback);
-        return reflections;
+    getAllReflections(): DeclarationReflection[] {
+        return flatMap(this.files, (file) => file.reflections);
     }
 }

src/lib/models/sources/file.ts

@@ -1,9 +1,9 @@
 import * as Path from "path";
 
-import type { Reflection } from "../reflections/abstract";
 import type { ReflectionGroup } from "../ReflectionGroup";
 import type { SourceDirectory } from "./directory";
 import type { RepositoryType } from "./repository";
+import type { DeclarationReflection } from "..";
 
 /**
  * Represents references of reflections to their defining source files.
@@ -79,7 +79,7 @@ export class SourceFile {
     /**
      * A list of all reflections that are declared in this file.
      */
-    reflections: Reflection[] = [];
+    reflections: DeclarationReflection[] = [];
 
     /**
      * A grouped list of the reflections declared in this file.

src/lib/output/themes/default/partials/member.tsx

@@ -1,4 +1,4 @@
-import { assertIsDeclarationReflection, renderFlags, wbr } from "../../lib";
+import { renderFlags, wbr } from "../../lib";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { JSX } from "../../../../utils";
 import { DeclarationReflection, ReferenceReflection } from "../../../../models";
@@ -20,8 +20,6 @@ export const member = (context: DefaultThemeRenderContext, props: DeclarationRef
             ? context.memberReference(props)
             : context.memberDeclaration(props)}
 
-        {props.groups?.map((item) =>
-            item.children.map((item) => !item.hasOwnDocument && context.member(assertIsDeclarationReflection(item)))
-        )}
+        {props.groups?.map((item) => item.children.map((item) => !item.hasOwnDocument && context.member(item)))}
     </section>
 );

src/lib/output/themes/default/partials/members.group.tsx

@@ -1,4 +1,3 @@
-import { assertIsDeclarationReflection } from "../../lib";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { JSX } from "../../../../utils";
 import type { ReflectionGroup } from "../../../../models";
@@ -13,9 +12,7 @@ export function membersGroup(context: DefaultThemeRenderContext, group: Reflecti
                             {!!item.title && <>{item.title} </>}
                             {group.title}
                         </h2>
-                        {item.children.map(
-                            (item) => !item.hasOwnDocument && context.member(assertIsDeclarationReflection(item))
-                        )}
+                        {item.children.map((item) => !item.hasOwnDocument && context.member(item))}
                     </section>
                 ))}
             </>
@@ -25,7 +22,7 @@ export function membersGroup(context: DefaultThemeRenderContext, group: Reflecti
     return (
         <section class={"tsd-panel-group tsd-member-group " + group.cssClasses}>
             <h2>{group.title}</h2>
-            {group.children.map((item) => !item.hasOwnDocument && context.member(assertIsDeclarationReflection(item)))}
+            {group.children.map((item) => !item.hasOwnDocument && context.member(item))}
         </section>
     );
 }

src/lib/output/themes/default/partials/members.tsx

@@ -1,4 +1,3 @@
-import { assertIsDeclarationReflection } from "../../lib";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { JSX } from "../../../../utils";
 import type { ContainerReflection } from "../../../../models";
@@ -12,10 +11,7 @@ export function members(context: DefaultThemeRenderContext, props: ContainerRefl
                         !item.allChildrenHaveOwnDocument() && (
                             <section class={"tsd-panel-group tsd-member-group " + props.cssClasses}>
                                 <h2>{item.title}</h2>
-                                {item.children.map(
-                                    (item) =>
-                                        !item.hasOwnDocument && context.member(assertIsDeclarationReflection(item))
-                                )}
+                                {item.children.map((item) => !item.hasOwnDocument && context.member(item))}
                             </section>
                         )
                 )}