@mui/internal-docs-infra/pipeline/loadServerSitemap/loadServerSitemap.d.mts

MUI Infra - internal documentation creation tools.

import type { Sitemap } from "../../createSitemap/types.mjs";
/**
 * Options for creating a loadServerSitemap function
 */
export interface CreateLoadServerSitemapOptions {
  /**
   * The root context directory for resolving relative paths.
   * Defaults to the directory containing the sitemap index file.
   */
  rootContext?: string;
}
/**
 * Function type for loading sitemap data from a sitemap index file URL
 */
export type LoadServerSitemap = (url: string) => Promise<Sitemap>;
/**
 * Creates the default Orama schema for search indexing.
 * See: <https://docs.orama.com/docs/orama-js/usage/create#schema-properties-and-types>
 */
export declare function createSitemapSchema(): Sitemap['schema'];
/**
 * Default loadServerSitemap function that loads sitemap data from a sitemap index file.
 * This function parses the sitemap index file to find createSitemap calls and resolves
 * the page index paths from the imports.
 */
export declare const loadServerSitemap: LoadServerSitemap;
/**
 * Creates a loadServerSitemap function with custom options.
 *
 * This factory function creates a LoadServerSitemap implementation that:
 * 1. Parses the sitemap index file to find createSitemap calls with page imports
 * 2. Resolves all page index paths from the imports
 * 3. Loads each page index using loadServerPageIndex
 * 4. Returns a Sitemap object with schema and page data
 *
 * @param options - Configuration options for the loader
 * @returns LoadServerSitemap function that takes a file URL and returns `Promise<Sitemap>`
 */
export declare function createLoadServerSitemap(options?: CreateLoadServerSitemapOptions): LoadServerSitemap;