Replacement of UrlMapping in v0.28?

[xuhdev]

UrlMapping seems to be gone in 0.28. Is there an equivalent?

I'm using UrlMapping to locate a specifically generated file: https://gitlab.com/8hobbies/typedoc-plugin-404/-/blob/263e03e05f13c18c1c6f126be795fc863f9f0322/index.ts#L46

/**
 * Add a 404 page.
 */
function add404Page(event: RendererEvent, page404Content: string): void {
  if (event.urls === undefined) {
    throw Error("URLs not detected. Unable to add a 404 page.");
  }

  // Add a URL mapping that's similar to the index page. Use the same model, and create the 404
  // page.
  const indexUrlMapping = event.urls.find(
    (element) => element.url === "index.html",
  );
  if (indexUrlMapping === undefined) {
    throw Error("Unable to find the URL mapping for the index page.");
  }
  const page404UrlMapping = new UrlMapping(
    "404.html",
    indexUrlMapping.model,
    (_) => {
      return JSX.createElement(
        "div",
        { class: "404-content" },
        JSX.createElement(JSX.Raw, { html: page404Content }),
      );
    },
  );

  event.urls.push(page404UrlMapping);
}

[Gerrit0]

You're after RendererEvent#pages

[xuhdev]

Thanks for pointing me to pages! However, it doesn't seem like pages allow me to specify the content of an additional page. Is there something I'm missing here?

[Gerrit0]

I didn't notice that, was on my way out the door... you're correct pages don't let you directly specify a callback to render the page, they're intended to be used to instruct the theme what it should render. As you're adding a page which the theme explicitly doesn't know how to render, that's not the right way to render it -- you should just write ${event.outputDirectory}/404.html yourself.

DefaultTheme.defaultLayoutTemplate should still work to wrap your HTML in the default layout, but it's not quite as easy as it used to be... perhaps I should look into how to expose the page type -> function mapping in DefaultTheme.render today so that it can be extended with a 404 page type by your plugin....