Fix misleading type annotation on getUrls

Resolves TypeStrong#2318.

CHANGELOG.md

@@ -13,6 +13,7 @@
 
 -   Fixed duplicate definitions in type hierarchy when using packages mode, #2327.
 -   `@inheritDoc` was not properly resolved across packages in packages mode, #2331.
+-   Fixed misleading type annotation on `Theme.getUrls`, #2318.
 
 ### Thanks!
 

src/lib/output/events.ts

@@ -3,7 +3,11 @@ import * as Path from "path";
 import { Event } from "../utils/events";
 import type { ProjectReflection } from "../models/reflections/project";
 import type { RenderTemplate, UrlMapping } from "./models/UrlMapping";
-import type { DeclarationReflection, ReflectionKind } from "../models";
+import type {
+    DeclarationReflection,
+    Reflection,
+    ReflectionKind,
+} from "../models";
 
 /**
  * An event emitted by the {@link Renderer} class at the very beginning and
@@ -28,7 +32,7 @@ export class RendererEvent extends Event {
      *
      * This list can be altered during the {@link Renderer.EVENT_BEGIN} event.
      */
-    urls?: UrlMapping[];
+    urls?: UrlMapping<Reflection>[];
 
     /**
      * Triggered before the renderer starts rendering a project.

src/lib/output/renderer.ts

@@ -13,7 +13,7 @@ import type { Application } from "../application";
 import type { Theme } from "./theme";
 import { RendererEvent, PageEvent, IndexEvent } from "./events";
 import type { ProjectReflection } from "../models/reflections/project";
-import type { RenderTemplate, UrlMapping } from "./models/UrlMapping";
+import type { RenderTemplate } from "./models/UrlMapping";
 import { writeFileSync } from "../utils/fs";
 import { DefaultTheme } from "./themes/default/DefaultTheme";
 import { RendererComponent } from "./components";
@@ -265,7 +265,7 @@ export class Renderer extends ChildableComponent<
             this.application.logger.verbose(
                 `There are ${output.urls.length} pages to write.`,
             );
-            output.urls.forEach((mapping: UrlMapping) => {
+            output.urls.forEach((mapping) => {
                 clearSeenIconCache();
                 this.renderDocument(...output.createPageEvent(mapping));
                 validateStateIsClean(mapping.url);

src/lib/output/theme.ts

@@ -41,7 +41,7 @@ export abstract class Theme extends RendererComponent {
      * @returns A list of {@link UrlMapping} instances defining which models
      * should be rendered to which files.
      */
-    abstract getUrls(project: ProjectReflection): UrlMapping[];
+    abstract getUrls(project: ProjectReflection): UrlMapping<Reflection>[];
 
     /**
      * Renders the provided page to a string, which will be written to disk by the {@link Renderer}