Make rendering types more lax

Author: Gerrit0

src/lib/output/components.ts

@@ -1,7 +1,7 @@
 import * as Path from "path";
 
 import { AbstractComponent } from "../utils/component.js";
-import type { ProjectReflection, Reflection } from "../models/index.js";
+import type { ProjectReflection } from "../models/index.js";
 import type { Renderer } from "./renderer.js";
 import { PageEvent, RendererEvent } from "./events.js";
 import { Option } from "../utils/index.js";
@@ -23,7 +23,7 @@ export abstract class ContextAwareRendererComponent extends RendererComponent {
     /**
      * The reflection that is currently processed.
      */
-    protected page?: PageEvent<Reflection>;
+    protected page?: PageEvent;
 
     /**
      * The url of the document that is being currently generated.
@@ -94,7 +94,7 @@ export abstract class ContextAwareRendererComponent extends RendererComponent {
      *
      * @param page  An event object describing the current render operation.
      */
-    protected onBeginPage(page: PageEvent<Reflection>) {
+    protected onBeginPage(page: PageEvent) {
         this.location = Path.posix.dirname(page.url);
         this.page = page;
     }

src/lib/output/events.ts

@@ -1,6 +1,11 @@
 import type { ProjectReflection } from "../models/ProjectReflection.js";
-import type { DeclarationReflection, DocumentReflection, ReflectionKind } from "../models/index.js";
-import type { PageDefinition, PageKind } from "./router.js";
+import {
+    type DeclarationReflection,
+    type DocumentReflection,
+    Reflection,
+    type ReflectionKind,
+} from "../models/index.js";
+import type { PageDefinition, PageKind, RouterTarget } from "./router.js";
 
 /**
  * An event emitted by the {@link Renderer} class at the very beginning and
@@ -63,7 +68,7 @@ export interface PageHeading {
  * @see {@link Renderer.EVENT_BEGIN_PAGE}
  * @see {@link Renderer.EVENT_END_PAGE}
  */
-export class PageEvent<out Model = unknown> {
+export class PageEvent<out Model extends RouterTarget = RouterTarget> {
     /**
      * The project the renderer is currently processing.
      */
@@ -139,6 +144,10 @@ export class PageEvent<out Model = unknown> {
     constructor(model: Model) {
         this.model = model;
     }
+
+    isReflectionEvent(): this is PageEvent<Reflection> {
+        return this.model instanceof Reflection;
+    }
 }
 
 /**

src/lib/output/plugins/JavascriptIndexPlugin.ts

@@ -1,7 +1,7 @@
 import * as Path from "path";
 import lunr from "lunr";
 
-import type { Comment, DeclarationReflection, DocumentReflection, Reflection } from "../../models/index.js";
+import { type Comment, type DeclarationReflection, type DocumentReflection, Reflection } from "../../models/index.js";
 import { RendererComponent } from "../components.js";
 import { IndexEvent, RendererEvent } from "../events.js";
 import { Option, writeFile } from "../../utils/index.js";
@@ -70,9 +70,10 @@ export class JavascriptIndexPlugin extends RendererComponent {
         const rows: SearchDocument[] = [];
 
         const initialSearchResults = this.owner
-            .router!.getLinkableReflections()
+            .router!.getLinkTargets()
             .filter(
                 (refl) =>
+                    refl instanceof Reflection &&
                     (refl.isDeclaration() || refl.isDocument()) &&
                     refl.name &&
                     !refl.flags.isExternal,

src/lib/output/renderer.ts

@@ -125,8 +125,8 @@ export interface RendererHooks {
 
 export interface RendererEvents {
     beginRender: [RendererEvent];
-    beginPage: [PageEvent<Reflection>];
-    endPage: [PageEvent<Reflection>];
+    beginPage: [PageEvent];
+    endPage: [PageEvent];
     endRender: [RendererEvent];
 
     parseMarkdown: [MarkdownEvent];
@@ -333,7 +333,7 @@ export class Renderer extends AbstractComponent<Application, RendererEvents> {
             `There are ${pages.length} pages to write.`,
         );
         for (const page of pages) {
-            this.renderDocument(outputDirectory, page);
+            this.renderDocument(outputDirectory, page, project);
         }
 
         this.postRenderAsyncJobs.push(async o => await this.theme!.postRender(o));
@@ -365,14 +365,14 @@ export class Renderer extends AbstractComponent<Application, RendererEvents> {
      * @param page An event describing the current page.
      * @return TRUE if the page has been saved to disc, otherwise FALSE.
      */
-    private renderDocument(outputDirectory: string, page: PageDefinition) {
+    private renderDocument(outputDirectory: string, page: PageDefinition, project: ProjectReflection) {
         const momento = this.hooks.saveMomento();
 
         const event = new PageEvent(page.model);
         event.url = page.url;
         event.filename = path.join(outputDirectory, page.url);
         event.pageKind = page.kind;
-        event.project = page.model.project;
+        event.project = project;
 
         this.trigger(PageEvent.BEGIN, event);