akte/dist/AkteFiles.d.ts

import { type Awaitable } from "./types";
type Path<TParams extends string[], TPrefix extends string = string> = TParams extends [] ? "" : TParams extends [string] ? `${TPrefix}:${TParams[0]}${string}` : TParams extends readonly [string, ...infer Rest extends string[]] ? Path<Rest, `${TPrefix}:${TParams[0]}${string}`> : string;
/**
 * A function responsible for fetching the data required to render a given file
 * at the provided path. Used for optimization like server side rendering or
 * serverless.
 */
export type FilesDataFn<TGlobalData, TParams extends string[], TData> = (context: {
    /** Path to get data for. */
    path: string;
    /** Path parameters if any. */
    params: Record<TParams[number], string>;
    /** Akte app global data. */
    globalData: TGlobalData;
}) => Awaitable<TData>;
/** A function responsible for fetching all the data required to render files. */
export type FilesBulkDataFn<TGlobalData, TData> = (context: {
    /** Akte app global data. */
    globalData: TGlobalData;
}) => Awaitable<Record<string, TData>>;
export type FilesDefinition<TGlobalData, TParams extends string[], TData> = {
    /**
     * Path pattern for the Akte files.
     *
     * @example
     * 	"/";
     * 	"/foo";
     * 	"/bar.json";
     * 	"/posts/:slug";
     * 	"/posts/:taxonomy/:slug";
     * 	"/pages/**";
     * 	"/assets/**.json";
     */
    path: Path<TParams>;
    /**
     * A function responsible for fetching the data required to render a given
     * file. Used for optimization like server side rendering or serverless.
     *
     * Throwing a {@link NotFoundError} makes the file at path to be treated as a
     * 404, any other error makes it treated as a 500.
     */
    data?: FilesDataFn<TGlobalData, TParams, TData>;
    /** A function responsible for fetching all the data required to render files. */
    bulkData?: FilesBulkDataFn<TGlobalData, TData>;
    /**
     * A function responsible for rendering the file.
     *
     * @param context - Resolved file path, app global data, and data to render
     *   the file.
     * @returns Rendered file.
     */
    render: (context: {
        /** Path to render. */
        path: string;
        /** Akte app global data. */
        globalData: TGlobalData;
        /** File data for path. */
        data: TData;
    }) => Awaitable<string>;
};
/** An Akte files, managing its data cascade and rendering process. */
export declare class AkteFiles<TGlobalData = unknown, TParams extends string[] = string[], TData = any> {
    protected definition: FilesDefinition<TGlobalData, TParams, TData>;
    /** Path pattern of this Akte files. */
    get path(): string;
    constructor(definition: FilesDefinition<TGlobalData, TParams, TData>);
    /** @internal Prefer {@link AkteApp.render} or use at your own risks. */
    render(args: {
        path: string;
        params: Record<TParams[number], string>;
        globalData: TGlobalData;
        data?: TData;
    }): Promise<string>;
    /** @internal Prefer {@link AkteApp.renderAll} or use at your own risks. */
    renderAll(args: {
        globalData: TGlobalData;
    }): Promise<Record<string, string>>;
    /** @internal Prefer {@link AkteApp.clearCache} or use at your own risks. */
    clearCache(): void;
    /**
     * Readonly cache of files' definition `data` method.
     *
     * @experimental Programmatic API might still change not following SemVer.
     */
    get dataMapCache(): ReadonlyMap<string, Awaitable<TData>>;
    private _dataMapCache;
    /**
     * Retrieves data from files' definition `data` method with given context.
     *
     * @param context - Context to get data with.
     * @returns Retrieved data.
     * @remark Returned data may come from cache.
     * @experimental Programmatic API might still change not following SemVer.
     */
    getData: FilesDataFn<TGlobalData, TParams, TData>;
    /**
     * Readonly cache of files' definition `bulkData` method.
     *
     * @experimental Programmatic API might still change not following SemVer.
     */
    get bulkDataCache(): Awaitable<Record<string, TData>> | undefined;
    private _bulkDataCache;
    /**
     * Retrieves data from files' definition `bulkData` method with given context.
     *
     * @param context - Context to get bulk data with.
     * @returns Retrieved bulk data.
     * @remark Returned bulk data may come from cache.
     * @experimental Programmatic API might still change not following SemVer.
     */
    getBulkData: FilesBulkDataFn<TGlobalData, TData>;
}
export {};