akte/dist/AkteApp.d.ts

import { type MatchedRoute, type RadixRouter } from "radix3";
import type { AkteFiles } from "./AkteFiles";
import type { Awaitable, GlobalDataFn } from "./types";
/** Akte app configuration object. */
export type Config<TGlobalData> = {
    /**
     * Akte files this config is responsible for.
     *
     * Create them with {@link defineAkteFile} and {@link defineAkteFiles}.
     */
    files: AkteFiles<TGlobalData>[];
    /** Configuration related to Akte build process. */
    build?: {
        /**
         * Output directory for Akte build command.
         *
         * @remarks
         *   This directory is overriden by the Akte Vite plugin when running Akte
         *   through Vite.
         * @defaultValue `"dist"` for Akte build command, `".akte"` for Akte Vite plugin.
         */
        outDir?: string;
    };
} & (TGlobalData extends Record<string | number | symbol, unknown> ? {
    /**
     * Global data retrieval function.
     *
     * The return value of this function is then shared with each Akte file.
     */
    globalData: GlobalDataFn<TGlobalData>;
} : {
    /**
     * Global data retrieval function.
     *
     * The return value of this function is then shared with each Akte file.
     */
    globalData?: GlobalDataFn<TGlobalData>;
});
/** An Akte app, ready to be interacted with. */
export declare class AkteApp<TGlobalData = unknown> {
    protected config: Config<TGlobalData>;
    /**
     * Readonly array of {@link AkteFiles} registered within the app.
     *
     * @experimental Programmatic API might still change not following SemVer.
     */
    get files(): AkteFiles<TGlobalData>[];
    constructor(config: Config<TGlobalData>);
    /**
     * Looks up the Akte file responsible for rendering the path.
     *
     * @param path - Path to lookup, e.g. "/foo"
     * @returns A match featuring the path, the path parameters if any, and the
     *   Akte file.
     * @throws {@link NotFoundError} When no Akte file is found for handling
     *   looked up path.
     * @experimental Programmatic API might still change not following SemVer.
     */
    lookup(path: string): MatchedRoute<{
        file: AkteFiles<TGlobalData>;
    }> & {
        path: string;
    };
    /**
     * Renders a match from {@link lookup}.
     *
     * @param match - Match to render.
     * @returns Rendered file.
     * @throws {@link NotFoundError} When the Akte file could not render the match
     *   (404), with an optional `cause` attached to it for uncaught errors (500)
     * @experimental Programmatic API might still change not following SemVer.
     */
    render(match: MatchedRoute<{
        file: AkteFiles<TGlobalData>;
    }> & {
        path: string;
        globalData?: TGlobalData;
        data?: unknown;
    }): Promise<string>;
    /**
     * Renders all Akte files.
     *
     * @returns Rendered files map.
     * @experimental Programmatic API might still change not following SemVer.
     */
    renderAll(): Promise<Record<string, string>>;
    /**
     * Writes a map of rendered Akte files to the specified `outDir`, or the app
     * specified one (defaults to `"dist"`).
     *
     * @param args - A map of rendered Akte files, and an optional `outDir`
     * @experimental Programmatic API might still change not following SemVer.
     */
    writeAll(args: {
        outDir?: string;
        files: Record<string, string>;
    }): Promise<void>;
    /**
     * Build (renders and write) all Akte files to the specified `outDir`, or the
     * app specified one (defaults to `"dist"`).
     *
     * @param args - An optional `outDir`
     * @returns Built files array.
     * @experimental Programmatic API might still change not following SemVer.
     */
    buildAll(args?: {
        outDir?: string;
    }): Promise<string[]>;
    /**
     * Akte caches all `globalData`, `data`, `bulkData` calls for performance.
     * This method can be used to clear the cache.
     *
     * @param alsoClearFileCache - Also clear cache on all registered Akte files.
     * @experimental Programmatic API might still change not following SemVer.
     */
    clearCache(alsoClearFileCache?: boolean): void;
    /**
     * Readonly cache of the app's definition `globalData` method.
     *
     * @experimental Programmatic API might still change not following SemVer.
     */
    get globalDataCache(): Awaitable<TGlobalData> | undefined;
    private _globalDataCache;
    /**
     * Retrieves data from the app's definition `globalData` method.
     *
     * @param context - Context to get global data with.
     * @returns Retrieved global data.
     * @remark Returned global data may come from cache.
     * @experimental Programmatic API might still change not following SemVer.
     */
    getGlobalData(): Awaitable<TGlobalData>;
    private _router;
    protected getRouter(): RadixRouter<{
        file: AkteFiles<TGlobalData>;
    }>;
}