@blinkk/root 3.0.1 → 3.0.3

package/dist/types-Cksf99CK.d.ts

@@ -1,827 +0,0 @@
-import { Express, Request as Request$1, Response as Response$1, NextFunction as NextFunction$1 } from 'express';
-import { ComponentType } from 'preact';
-import { PluginOption, UserConfig, ViteDevServer } from 'vite';
-import { J as JsxRenderOptions } from './jsx-C8BaDh-4.js';
-import { Options } from 'html-minifier-terser';
-import { HTMLBeautifyOptions } from 'js-beautify';
-
-declare class Hooks {
-    private callbacks;
-    add(name: string, cb: (...args: any[]) => any): void;
-    trigger(name: string, ...args: any[]): void;
-}
-
-declare const SESSION_COOKIE = "__session";
-interface SessionMiddlewareOptions {
-    maxAge?: number;
-}
-interface SaveSessionOptions {
-    sameSite?: 'strict' | 'lax' | 'none';
-}
-/**
- * Middleware for storing session data stored in an http cookie called
- * `__session`. This cookie is compatible with Firebase Hosting:
- * https://firebase.google.com/docs/hosting/manage-cache#using_cookies
- */
-declare function sessionMiddleware(options?: SessionMiddlewareOptions): (req: Request, res: Response, next: NextFunction) => void;
-declare class Session {
-    private data;
-    hasChanges: boolean;
-    constructor(data?: Record<string, string>);
-    static fromCookieValue(cookieValue: string): Session;
-    getItem(key: string): string | null;
-    setItem(key: string, value: string): void;
-    removeItem(key: string): void;
-    toString(): string;
-}
-
-type HtmlMinifyOptions = Options;
-
-type HtmlPrettyOptions = HTMLBeautifyOptions;
-
-interface Pod {
-    /** Unique pod name, e.g. '@blinkk/root-docs-pod'. */
-    name: string;
-    /**
-     * URL prefix for pod routes. Routes within the pod are served under this
-     * mount path. Defaults to '/'.
-     */
-    mount?: string;
-    /**
-     * Priority for route conflict resolution. Higher values win when multiple
-     * pods register the same URL path. User-site routes always take precedence
-     * regardless of priority. Defaults to 0.
-     */
-    priority?: number;
-    /** Absolute path to the pod's routes/ directory. */
-    routesDir?: string;
-    /** Absolute path(s) to the pod's elements/ directory(s). */
-    elementsDirs?: string[];
-    /** Absolute path to the pod's bundles/ directory. */
-    bundlesDir?: string;
-    /** Absolute path to the pod's collections/ directory (root-cms only). */
-    collectionsDir?: string;
-    /** Absolute path to the pod's translations/ directory. */
-    translationsDir?: string;
-    /** Extra Vite plugins contributed by the pod. */
-    vitePlugins?: PluginOption[];
-}
-type PodFactory = (ctx: {
-    rootConfig: RootConfig;
-}) => Pod | Promise<Pod>;
-interface PodConfig {
-    /** Whether the pod is enabled. Defaults to true. */
-    enabled?: boolean;
-    /** Override the pod's mount path. */
-    mount?: string;
-    /** Override the pod's priority. */
-    priority?: number;
-    /** Filter pod routes. */
-    routes?: {
-        exclude?: (string | RegExp)[];
-    };
-    /** Configure pod collections. */
-    collections?: {
-        exclude?: string[];
-        /** Rename collection ids, e.g. {Posts: 'DocsPosts'}. */
-        rename?: Record<string, string>;
-    };
-}
-/**
- * Helper to define a pod with type-checking.
- */
-declare function definePod(pod: Pod): Pod;
-
-type MaybePromise<T> = T | Promise<T>;
-type PreBuildHook = (rootConfig: RootConfig) => MaybePromise<void>;
-interface PostBuildOptions {
-    /** Whether the build was SSR-only (no SSG pre-rendering). */
-    ssrOnly?: boolean;
-}
-type PostBuildHook = (rootConfig: RootConfig, options?: PostBuildOptions) => MaybePromise<void>;
-type ConfigureServerHook = (server: Server, options: ConfigureServerOptions) => MaybePromise<void> | MaybePromise<() => void>;
-interface ConfigureServerOptions {
-    type: 'dev' | 'preview' | 'prod';
-    rootConfig: RootConfig;
-}
-interface PluginHooks {
-    /**
-     * Hook that runs before the build starts.
-     */
-    preBuild?: PreBuildHook;
-    /**
-     * Hook that runs after the build completes.
-     */
-    postBuild?: PostBuildHook;
-    /**
-     * Post-render hook that's called before the HTML is rendered to the response
-     * object. If a string is returned from this hook, it will replace the
-     * rendered HTML.
-     */
-    preRender?: (html: string) => void | MaybePromise<string>;
-}
-interface Plugin {
-    [key: string]: any;
-    /** The name of the plugin. */
-    name?: string;
-    /**
-     * Configures the root.js express server. Any middleware defined by the plugin
-     * will be added to the server first. If a callback fn is returned, it will
-     * be called after the root.js middlewares are added.
-     */
-    configureServer?: ConfigureServerHook;
-    /**
-     * Hook for file changes.
-     */
-    onFileChange?: (eventName: 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir', path: string) => void;
-    /**
-     * Returns a list of deps to bundle for ssr. The files will be bundled and
-     * output to `dist/server/`. The return value should be a map of
-     * `{output filename => input filepath}`.
-     *
-     * E.g. a value of `{foo: 'path/to/bar.js'}` will output `dist/server/foo.js`.
-     *
-     * @experimental This config is subject to change to be incorporated into a
-     * broader config option called "ssr" or "ssrOptions".
-     */
-    ssrInput?: () => {
-        [entryAlias: string]: string;
-    };
-    /** Adds vite plugins. */
-    vitePlugins?: PluginOption[];
-    /** Plugin lifecycle callback hooks. */
-    hooks?: PluginHooks;
-    /** Custom 404 handler. */
-    handle404?: (req: Request, res: Response, next: NextFunction) => void | Promise<void>;
-    /**
-     * Registers a pod (a mini root.js site) that gets merged into the parent
-     * site at dev/build time. A plugin may return a single pod, an array of
-     * pods, or a factory that receives the rootConfig.
-     */
-    pod?: Pod | Pod[] | PodFactory;
-}
-/**
- * Runs the pre-hook configureServer method of every plugin, calls a callback
- * function, and then runs the configureServer's post-hook if provided. Plugins
- * provide a post-hook by returning a callback function from configureServer.
- */
-declare function configureServerPlugins(server: Server, callback: () => Promise<void>, plugins: Plugin[], options: ConfigureServerOptions): Promise<void>;
-declare function getVitePlugins(plugins: Plugin[]): PluginOption[];
-
-interface RootUserConfig {
-    /**
-     * Canonical domain the website will serve on. Useful for things like the
-     * sitemap, SEO tags, etc.
-     */
-    domain?: string;
-    /**
-     * The base URL path that the site will serve on. Defaults to `/`;
-     */
-    base?: string;
-    /**
-     * Config for auto-injecting custom element dependencies.
-     */
-    elements?: {
-        /**
-         * A list of directories to use to look for custom elements. The dir path
-         * should be relative to the project dir, e.g. "path/to/elements".
-         */
-        include?: string[];
-        /**
-         * A list of RegEx patterns to exclude. The string passed to the RegEx is
-         * the file URL relative to the project root, e.g. "/elements/foo/foo.ts".
-         */
-        exclude?: RegExp[];
-    };
-    /**
-     * Config for manually injecting stylesheet entries as
-     * `<link rel="stylesheet">` tags.
-     */
-    styles?: {
-        /**
-         * Project-root-relative stylesheet files to include on every rendered
-         * page, e.g. `styles/index.css`.
-         *
-         * Entries are normalized as URL paths, so both `styles/index.css` and
-         * `/styles/index.css` resolve to `/styles/index.css`.
-         *
-         * Manual entries are injected first, then auto-collected CSS
-         * dependencies are merged after. Duplicate URLs are de-duped so each
-         * stylesheet is only injected once.
-         */
-        entries?: string[];
-    };
-    /**
-     * Config options for localization and internationalization.
-     */
-    i18n?: RootI18nConfig;
-    /**
-     * Config options for the Root.js express server.
-     */
-    server?: RootServerConfig;
-    /**
-     * Build options for the `root build` command.
-     */
-    build?: RootBuildConfig;
-    /**
-     * Vite config.
-     * @see {@link https://vitejs.dev/config/} for more information.
-     */
-    vite?: UserConfig;
-    /**
-     * Config for the built-in JSX-to-HTML renderer.
-     *
-     * - `mode: 'pretty'` (default) — block-level elements render on their own
-     *   line with no indentation.
-     * - `mode: 'minimal'` — compact output with no extra whitespace.
-     *
-     * Use `blockElements` to specify additional custom element tag names that
-     * should be treated as block-level in pretty mode.
-     *
-     * @example
-     * ```ts
-     * export default defineConfig({
-     *   jsxRenderer: {
-     *     mode: 'pretty',
-     *     blockElements: ['my-card', 'my-section'],
-     *   },
-     * });
-     * ```
-     */
-    jsxRenderer?: JsxRenderOptions;
-    /**
-     * Whether to automatically minify HTML output. This is enabled by default,
-     * in order to disable, pass `minifyHtml: false` to root.config.ts.
-     */
-    minifyHtml?: boolean;
-    /**
-     * Options to pass to html-minifier-terser.
-     */
-    minifyHtmlOptions?: HtmlMinifyOptions;
-    /**
-     * Whether to pretty print HTML output.
-     */
-    prettyHtml?: boolean;
-    /**
-     * Options to pass to js-beautify.
-     */
-    prettyHtmlOptions?: HtmlPrettyOptions;
-    /**
-     * Whether to include a sitemap.xml file to the build output.
-     */
-    sitemap?: boolean;
-    /**
-     * Plugins.
-     */
-    plugins?: Plugin[];
-    /**
-     * Per-pod user-level overrides. The key is the pod name as declared in
-     * Pod.name.
-     */
-    pods?: Record<string, PodConfig>;
-    /**
-     * Experimental config options. Note: these are subject to change at any time.
-     */
-    experiments?: {
-        /** Whether to render `<script>` tags with `async`. */
-        enableScriptAsync?: boolean;
-    };
-}
-type RootConfig = RootUserConfig & {
-    rootDir: string;
-};
-interface LocaleGroup {
-    label?: string;
-    locales: string[];
-}
-interface RootI18nConfig {
-    /**
-     * Locales enabled for the site.
-     */
-    locales?: string[];
-    /**
-     * The default locale to use. Defaults is `en`.
-     */
-    defaultLocale?: string;
-    /**
-     * URL format for localized content. Default is `/[locale]/[base]/[path]`.
-     */
-    urlFormat?: string;
-    /**
-     * Localization groups, to help UIs (like Root.js CMS) logically group
-     * locales.
-     */
-    groups?: Record<string, LocaleGroup>;
-}
-interface RootBuildConfig {
-    /**
-     * Excludes the `/intl/{defaultLocale}/...` path from the SSG build.
-     */
-    excludeDefaultLocaleFromIntlPaths?: boolean;
-}
-interface RootRedirectConfig {
-    /**
-     * The source path to redirect. Accepts placeholders in the format
-     * `[key]` or `[...key]`. Use `[key]` for single segments and
-     * `[...key]` for multi-segment wildcards.
-     * @example "/old-path/[id]" or "/old-path/[...wildcard]"
-     */
-    source: string;
-    /**
-     * The destination to redirect to. Placeholders from the source can
-     * optionally be inserted into the destination using the same
-     * placeholder format.
-     * @example "/new-path/[id]" or "/new-path/[...wildcard]"
-     */
-    destination: string;
-    /**
-     * The redirect type (`301` = permanent, `302` = temporary). If unspecified,
-     * defaults to `302` (temporary).
-     */
-    type?: 301 | 302;
-}
-interface RootHeaderConfig {
-    /** A glob pattern match (regex not supported yet). */
-    source: string;
-    headers: Array<{
-        key: string;
-        value: string;
-    }>;
-}
-interface ContentSecurityPolicyConfig {
-    directives?: Record<string, string[]>;
-    reportOnly?: boolean;
-}
-interface XFrameOptionsConfig {
-    action: 'DENY' | 'SAMEORIGIN';
-}
-interface RootSecurityConfig {
-    /**
-     * Content-Security-Policy config. If enabled, a nonce is auto-generated
-     * for every request and appended to script and stylesheet tags. You can
-     * validate your CSP headers using a tool like {@link https://csp-evaluator.withgoogle.com/}.
-     *
-     * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP}
-     */
-    contentSecurityPolicy?: ContentSecurityPolicyConfig | boolean;
-    /**
-     * Strict-Transport-Security config. When enabled, the header value is set
-     * to `Strict-Transport-Security: max-age=63072000; includeSubDomains; preload`.
-     */
-    strictTransportSecurity?: boolean;
-    /**
-     * X-Content-Type-Options config. When enabled, the header value is set to
-     * `X-Content-Type-Options: nosniff`.
-     */
-    xContentTypeOptions?: boolean;
-    /**
-     * X-Frame-Options config. Setting this value to `true` will default the
-     * header value to `X-Frame-Options: SAMEORIGIN`.
-     *
-     * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options}
-     */
-    xFrameOptions?: 'DENY' | 'SAMEORIGIN' | boolean;
-    /**
-     * X-XSS-Protection config. When enabled, the header value is set to
-     * `X-XSS-Protection: 1; mode=block`.
-     */
-    xXssProtection?: boolean;
-}
-interface RootServerConfig {
-    /**
-     * An array of middleware to add to the express server. These middleware are
-     * added to the beginning of the express app.
-     */
-    middlewares?: RequestMiddleware[];
-    /**
-     * The `trailingSlash` config allows you to control how the server handles
-     * trailing slashes. This config only affects URLs that do not have a file
-     * extension (i.e. HTML paths).
-     *
-     * - When `true`, the server redirects URLs to add a trailing slash
-     * - When `false`, the server redirects URLs to remove a trailing slash
-     * - When unspecified, the server allows URLs with and without trailing slash
-     */
-    trailingSlash?: boolean;
-    /**
-     * Cookie secret for the session middleware.
-     *
-     * Generate a secure secret with:
-     * ```
-     * node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
-     * ```
-     */
-    sessionCookieSecret?: string | string[];
-    /**
-     * List of redirects. Supports optional wildcards.
-     *
-     * @example
-     * ```ts
-     * redirects: [
-     *   {
-     *     source: '/old-path/[id]',
-     *     destination: '/new-path/[id]',
-     *     type: 301,
-     *   },
-     *   {
-     *     source: '/old-path/[...wildcard]',
-     *     destination: '/new-path/[...wildcard]',
-     *   },
-     * ]
-     * ```
-     */
-    redirects?: RootRedirectConfig[];
-    /**
-     * HTTP headers to add to a response.
-     */
-    headers?: RootHeaderConfig[];
-    /**
-     * HTTP security settings. By default, all security settings are enabled with
-     * commonly used default values.
-     */
-    security?: RootSecurityConfig;
-    /**
-     * Home page URL path, which is printed when the dev server starts.
-     */
-    homePagePath?: string;
-}
-declare function defineConfig(config: RootUserConfig): RootUserConfig;
-
-interface ElementSourceFile {
-    /** Full file path. */
-    filePath: string;
-    /** Path relative to the root project directory. */
-    relPath: string;
-}
-/**
- * Dependency graph for element files to capture which other elements are used
- * by any particular element.
- */
-declare class ElementGraph {
-    /**
-     * Element tagName => sourceFile.
-     */
-    readonly sourceFiles: {
-        [tagName: string]: ElementSourceFile;
-    };
-    /**
-     * Element tagName => set of element tagName dependencies.
-     */
-    private deps;
-    constructor(sourceFiles: {
-        [tagName: string]: ElementSourceFile;
-    });
-    toJson(): {
-        sourceFiles: {
-            [tagName: string]: ElementSourceFile;
-        };
-        deps: Record<string, string[]>;
-    };
-    static fromJson(data: {
-        deps: any;
-        sourceFiles: any;
-    }): ElementGraph;
-    getDeps(tagName: string, visited?: Set<string>): string[];
-    /**
-     * Parses an element's source file for usage of other custom elements.
-     */
-    private parseDepsFromSource;
-}
-
-interface Asset {
-    /**
-     * The path to the asset's src file, relative to the project root.
-     */
-    src: string;
-    /**
-     * The serving URL for the asset.
-     */
-    assetUrl: string;
-    /**
-     * Recursively walks all deps and returns a list of CSS asset URLs.
-     */
-    getCssDeps(): Promise<string[]>;
-    /**
-     * Recursively walks all deps and returns a list of JS asset URLs.
-     */
-    getJsDeps(): Promise<string[]>;
-}
-interface AssetMap {
-    /**
-     * Returns the asset for a given src file. The `src` value should be a path
-     * relative to the project root, e.g. "routes/index.tsx".
-     */
-    get: (src: string) => Promise<Asset | null>;
-}
-
-declare class Renderer {
-    private rootConfig;
-    private assetMap;
-    private elementGraph;
-    private router;
-    constructor(rootConfig: RootConfig, options: {
-        assetMap: AssetMap;
-        elementGraph: ElementGraph;
-    });
-    /** Returns a route from the router. */
-    getRoute(url: string): [Route | undefined, Record<string, string>];
-    handle(req: Request, res: Response, next: NextFunction): Promise<void>;
-    private renderComponent;
-    /** SSG renders a route. */
-    renderRoute(route: Route, options: {
-        routeParams: Record<string, string>;
-    }): Promise<{
-        html?: string;
-        notFound?: boolean;
-    }>;
-    /** Handles the SSR rendering of a route. */
-    handleRoute(req: Request, res: Response, next: NextFunction, route: Route, options?: {
-        defaultStatusCode?: number;
-        /**
-         * URL placeholder params.
-         */
-        routeParams?: Record<string, string>;
-        /**
-         * Handler function that tries the next matching route if multiple routes
-         * match for a given url path.
-         */
-        nextRouteHandler?: () => void | Promise<void>;
-    }): Promise<void>;
-    /**
-     * Constructs and returns the project's sitemap.
-     *
-     * The sitemap is used to:
-     * - determine all paths to build in SSG mode
-     * - display links on the dev server's 404 page
-     * - construct alternates for localized URL paths
-     */
-    getSitemap(): Promise<Sitemap>;
-    private getJsxRenderOptions;
-    /**
-     * Renders JSX via either the `@blinkk/root/jsx` package or
-     * `preact-render-to-string` depending if the `jsxRenderer` config is set up
-     * in `root.config.ts`.
-     */
-    private renderJsx;
-    private getConfiguredStyleEntries;
-    private renderHtml;
-    private ensureNewline;
-    render404(options?: {
-        currentPath?: string;
-    }): Promise<{
-        html: string;
-    }>;
-    renderError(err: any, options?: {
-        currentPath?: string;
-    }): Promise<{
-        html: string;
-    }>;
-    renderDevServer404(req: Request): Promise<{
-        html: string;
-    }>;
-    renderDevServer500(req: Request, error: unknown): Promise<{
-        html: string;
-    }>;
-    /**
-     * Parses rendered HTML for custom element tags used on the page and
-     * automatically adds the JS/CSS deps to the page.
-     */
-    private collectElementDeps;
-    /**
-     * Returns the `security` config value with default values inserted wherever
-     * a user config value is blank or set to `true`.
-     */
-    private getSecurityConfig;
-    /**
-     * Generates a random string that can be used as the "nonce" value for CSP.
-     */
-    private generateNonce;
-    /**
-     * Sets security-related HTTP headers.
-     */
-    private setSecurityHeaders;
-}
-
-/**
- * Param values from the route, e.g. a route like `/route/[slug].tsx` will pass
- * `{slug: 'foo'}`.
- */
-type RouteParams = Record<string, string>;
-/**
- * The `getStaticProps()` function is an optional function that routes can
- * define to fetch and transform props before passing it to the route's
- * component.
- */
-type GetStaticProps<T = unknown> = (ctx: {
-    rootConfig: RootConfig;
-    params: RouteParams;
-}) => Promise<{
-    /** Props to pass to the component. */
-    props?: T;
-    /** The rendered locale. */
-    locale?: string;
-    /**
-     * Translations to pass to `useTranslations()`. If provided, the translations
-     * map passed here will be merged with the translations from
-     * `/translations/{locale}.json`.
-     */
-    translations?: Record<string, string>;
-    /**  Set to true if the route should result in a 404 page. */
-    notFound?: boolean;
-}>;
-/**
- * The `getStaticPaths()` is used by the SSG build to determine all of the
- * paths that exist for a given route. This should be used alongside a
- * parameterized route, e.g. `/routes/blog/[slug].tsx`.
- */
-type GetStaticPaths<T = RouteParams> = (ctx: {
-    rootConfig: RootConfig;
-}) => Promise<{
-    paths: Array<{
-        params: T;
-    }>;
-}>;
-/** Multipart file type for the multipartMiddleware(). */
-interface MultipartFile {
-    fieldname: string;
-    originalName: string;
-    encoding: string;
-    mimetype: string;
-    buffer: Buffer;
-}
-type RequestMiddleware = ((req: Request, res: Response) => any) | ((req: Request, res: Response, next: NextFunction) => any) | ((err: any, req: Request, res: Response, next: NextFunction) => any);
-/** Root.js express app. */
-type Server = Express & {
-    use(middlewares: RequestMiddleware | RequestMiddleware[]): any;
-    use(urlPath: string, middlewares: RequestMiddleware | RequestMiddleware[]): any;
-};
-/** Root.js express request. */
-type Request = Request$1 & {
-    /** The root.js project config. */
-    rootConfig?: RootConfig & {
-        rootDir: string;
-    };
-    /** The vite dev server. This is only available when running `root dev`. */
-    viteServer?: ViteDevServer;
-    /** The root.js renderer, to render routes within middleware. */
-    renderer?: Renderer;
-    /** Logged in user for the request. */
-    user?: {
-        email: string;
-    };
-    /**
-     * Handler context, provided to route files that export a custom `handler()`
-     * function.
-     */
-    handlerContext?: HandlerContext;
-    hooks: Hooks;
-    /** Gets and sets session data via cookie. */
-    session: Session;
-    /** Firebase functions uses rawBody for its multipart data. */
-    rawBody?: any;
-    /** Map of field name to file. */
-    files?: {
-        [fieldname: string]: MultipartFile;
-    };
-};
-/** Root.js express response. */
-type Response = Response$1 & {
-    session: Session;
-    saveSession: (options?: SaveSessionOptions) => void;
-};
-/** Root.js express next function. */
-type NextFunction = NextFunction$1;
-/**
- * A context variable passed to a route's `handle()` method within the req
- * object.
- */
-interface HandlerContext<Props = any> {
-    /**
-     * The resolved route.
-     */
-    route: Route;
-    /**
-     * Param values from the route, e.g. a route like `/route/[slug].tsx` will
-     * pass `{slug: 'foo'}`.
-     */
-    params: RouteParams;
-    /**
-     * i18n locales to try for the user's http request. The priority order mimics
-     * the Firebase Hosting i18n fallback logic.
-     * https://firebase.google.com/docs/hosting/i18n-rewrites#priority-order
-     */
-    i18nFallbackLocales: string[];
-    /**
-     * Iterates through the i18nFallbackLocales and returns the first available
-     * locale.
-     */
-    getPreferredLocale: (availableLocales: string[]) => string;
-    /** Renders the default exported component from the route. */
-    render: HandlerRenderFn<Props>;
-    /**
-     * Renders a 404 page. When `nextRoute` is true, the next matching route
-     * handler will be invoked instead of rendering the default 404 page.
-     */
-    render404: (options?: {
-        nextRoute?: boolean;
-    }) => Promise<void>;
-}
-/**
- * The `handle()` function can be exported by a route to define a custom express
- * request handler. The `req` object will contain a `handlerContext` which
- * contains the route's param values and also a `render()` method that can be
- * used to render the route's default component.
- */
-type Handler = (req: Request, res: Response, next: NextFunction) => void | Promise<void>;
-interface StaticContentResult {
-    body: string;
-    contentType?: string;
-}
-/**
- * The `getStaticContent()` function is a SSG handler function for non-HTML
- * routes, e.g. `routes/sitemap.xml.ts`.
- *
- * If the route exports a `getStaticProps()` function, the props returned from
- * that function is passed to `getStaticContent()`. Otherwise a default props
- * value is passed which includes the `rootConfig` and route param values.
- */
-type GetStaticContent = (props: any) => Promise<StaticContentResult | string> | StaticContentResult | string;
-interface RouteModule {
-    default?: ComponentType<unknown>;
-    getStaticPaths?: GetStaticPaths;
-    getStaticProps?: GetStaticProps;
-    handle?: Handler;
-    getStaticContent?: GetStaticContent;
-}
-interface Route {
-    /** The relative path to the route file, e.g. `routes/index.tsx`. */
-    src: string;
-    /** The imported route module. */
-    module: RouteModule;
-    /** The locale used for the route. */
-    locale: string;
-    /**
-     * Returns `true` if the route is the default locale route mapped without the
-     * i18n url prefix. For example, a route may be mapped to `/foo` and
-     * `/[locale]/foo`. The `/foo` route would have `route.isDefaultLocale` set to
-     * `true` whereas for `/[locale]/foo` it would be `false`.
-     */
-    isDefaultLocale: boolean;
-    /**
-     * The mapped URL path for the route, e.g.:
-     *
-     *   routes/index.tsx => `/`.
-     *   routes/events.tsx => `/events`.
-     *   routes/blog/[slug].tsx => `/blog/[slug]`.
-     *
-     * Per the example above, this value may contain placeholder params.
-     */
-    routePath: string;
-    /**
-     * The localized URL path for the route, e.g. `/[locale]/blog/[slug]`.
-     * Per the example above, this value contains placeholder params.
-     */
-    localeRoutePath: string;
-    /**
-     * The name of the pod that contributed this route, or undefined if the
-     * route is from the user's project.
-     */
-    podName?: string;
-}
-interface HandlerRenderOptions {
-    /** HTTP status code to return. Defaults to 200. */
-    statusCode?: number;
-    /** The rendered locale. */
-    locale?: string;
-    /**
-     * Translations to pass to `useTranslations()`. If provided, the translations
-     * map passed here will be merged with the translations from
-     * `/translations/{locale}.json`.
-     */
-    translations?: Record<string, string>;
-}
-type HandlerRenderFn<Props = any> = (props: Props, options?: HandlerRenderOptions) => Promise<void>;
-/**
- * Sitemap is a map of URL path -> route info.
- */
-type Sitemap = Record<string, SitemapItem>;
-/**
- * Sitemap route info. The "default locale" route provides "alts" that can be
- * used for outputting the localized url paths.
- */
-interface SitemapItem {
-    urlPath: string;
-    route: Route;
-    params: Record<string, string>;
-    locale: string;
-    hrefLang: string;
-    /**
-     * Hreflang alts.
-     */
-    alts: Record<string, {
-        hrefLang: string;
-        urlPath: string;
-    }>;
-}
-
-export { type RouteParams as A, type GetStaticPaths as B, type ContentSecurityPolicyConfig as C, type RequestMiddleware as D, type Handler as E, type StaticContentResult as F, type GetStaticProps as G, type HandlerContext as H, type GetStaticContent as I, type RouteModule as J, type HandlerRenderOptions as K, type LocaleGroup as L, type MultipartFile as M, type NextFunction as N, type HandlerRenderFn as O, type PodConfig as P, type Sitemap as Q, type RootConfig as R, SESSION_COOKIE as S, type SitemapItem as T, Renderer as U, type XFrameOptionsConfig as X, type Request as a, type Response as b, type SessionMiddlewareOptions as c, type SaveSessionOptions as d, Session as e, type Server as f, type Route as g, type RootUserConfig as h, type RootI18nConfig as i, type RootBuildConfig as j, type RootRedirectConfig as k, type RootHeaderConfig as l, type RootSecurityConfig as m, type RootServerConfig as n, defineConfig as o, type Pod as p, type PodFactory as q, definePod as r, sessionMiddleware as s, type PostBuildOptions as t, type ConfigureServerHook as u, type ConfigureServerOptions as v, type PluginHooks as w, type Plugin as x, configureServerPlugins as y, getVitePlugins as z };