Context.withScope is now used consistently

Author: Gerrit0

src/index.ts

@@ -63,7 +63,6 @@ export {
     StructureDirRouter,
     StructureRouter,
     Theme,
-    UrlMapping,
 } from "./lib/output/index.js";
 export type {
     Icons,

src/lib/converter/context.ts

@@ -368,8 +368,7 @@ export class Context {
     }
 
     public withScope(scope: Reflection): Context {
-        // TODO: This will be important for #2862
-        // assert(scope.parent === this.scope, "Incorrect context used for withScope");
+        assert(scope.parent === this.scope || scope === this.scope, "Incorrect context used for withScope");
 
         const context = new Context(
             this.converter,

src/lib/converter/factories/index-signature.ts

@@ -51,6 +51,7 @@ export function convertIndexSignatures(context: Context, type: ts.Type) {
             ReflectionKind.IndexSignature,
             context.scope,
         );
+        const ic = context.withScope(index);
         if (indexInfo.isReadonly) {
             index.setFlag(ReflectionFlag.Readonly);
         }
@@ -72,11 +73,11 @@ export function convertIndexSignatures(context: Context, type: ts.Type) {
             ),
         ];
         index.parameters[0].type = context.converter.convertType(
-            context.withScope(index.parameters[0]),
+            ic.withScope(index.parameters[0]),
             indexInfo.keyType,
         );
         index.type = context.converter.convertType(
-            context.withScope(index),
+            ic,
             indexInfo.type,
         );
 

src/lib/converter/jsdoc.ts

@@ -119,6 +119,7 @@ function convertJsDocSignature(context: Context, node: ts.JSDocSignature) {
         ReflectionKind.TypeLiteral,
         context.scope,
     );
+    const rc = context.withScope(reflection);
     context.registerReflection(reflection, symbol);
     context.converter.trigger(
         ConverterEvents.CREATE_DECLARATION,
@@ -136,7 +137,7 @@ function convertJsDocSignature(context: Context, node: ts.JSDocSignature) {
         createSymbolId(symbol, node),
     );
     context.registerReflection(signature, void 0);
-    const signatureCtx = context.withScope(signature);
+    const signatureCtx = rc.withScope(signature);
 
     reflection.signatures = [signature];
     signature.type = context.converter.convertType(

src/lib/output/index.ts

@@ -1,10 +1,8 @@
 export { IndexEvent, MarkdownEvent, PageEvent, type PageHeading, RendererEvent } from "./events.js";
-export { UrlMapping } from "./models/UrlMapping.js";
-export type { RenderTemplate } from "./models/UrlMapping.js";
 export { Renderer, type RendererEvents } from "./renderer.js";
 export type { RendererHooks } from "./renderer.js";
 export { Theme } from "./theme.js";
-export { DefaultTheme, type NavigationElement } from "./themes/default/DefaultTheme.js";
+export { DefaultTheme, type NavigationElement, type RenderTemplate } from "./themes/default/DefaultTheme.js";
 export { DefaultThemeRenderContext } from "./themes/default/DefaultThemeRenderContext.js";
 export type { Icons } from "./themes/default/partials/icon.js";
 export { Slugger } from "./themes/default/Slugger.js";

src/lib/output/models/UrlMapping.ts

@@ -11,7 +11,6 @@ import {
     ReflectionGroup,
     ReflectionKind,
 } from "../../../models/index.js";
-import { type RenderTemplate } from "../../models/UrlMapping.js";
 import type { PageEvent } from "../../events.js";
 import type { MarkedPlugin } from "../../plugins/index.js";
 import { DefaultThemeRenderContext } from "./DefaultThemeRenderContext.js";
@@ -29,6 +28,12 @@ export interface NavigationElement {
     children?: NavigationElement[];
 }
 
+/**
+ * @param data the reflection to render
+ * @returns either a string to be written to the file, or an element to be serialized and then written.
+ */
+export type RenderTemplate<T> = (data: T) => JSX.Element | string;
+
 export class DefaultTheme extends Theme {
     // Note: This will always contain lowercased names to avoid issues with
     // case-insensitive file systems.