/** * vapor-chamber/router — the loader SPI. * * The router core knows WHEN data loads (on navigation, abort-on-supersede, * two-phase committed onto the snapshot; on query-only changes, refetch of * affected loaders only). It does NOT know HOW: that's a preset's job, * resolved from the route row's `load` string — * * registered prefix wins: "rows:products" → handlers.prefixes['rows:'] * otherwise a URL template: "/api/x?page={page}" → handlers.url * * In-box preset: `vapor-chamber/router-fetch` (plain JSON backends). Any other * backend convention is a preset returning LoaderHandlers. A load with no * matching handler is a coded 'load_failed'. */ import type { QueryParamDef, RouteLocation, TableRecord } from './types'; /** Handles `load` values under a registered prefix * ('rows:products' → ref 'products'). */ export type PrefixHandler = (ref: string, location: RouteLocation, record: TableRecord, signal: AbortSignal) => unknown | Promise; /** Handles plain URL-template `load` values. Receives the RAW template — * interpolation (interpolateLoad) is the handler's choice. */ export type UrlHandler = (template: string, location: RouteLocation, record: TableRecord, signal: AbortSignal) => unknown | Promise; export type LoaderHandlers = { prefixes?: Record; url?: UrlHandler; /** Decide whether a query-only change in `changedKeys` requires this * record's loader to refetch. Default (`defaultAffects`): a prefix/row-source * loader depends on its declared query params plus `page`/`per_page`/`sort`; * a URL template depends only on the `{placeholders}` it mentions. Resolved * once at `createRouter` — override for a preset with different query * semantics. */ affects?: (record: TableRecord, changedKeys: readonly string[]) => boolean; }; /** Fill `{placeholders}` from path params first, then typed query params * (declared defaults apply — `{page}` is `1` when absent), else ''. */ export declare function interpolateLoad(template: string, location: RouteLocation, queryDefs: Record): string; /** Run every loader in a record chain. Results keyed by record name; * failures throw coded RouterErrors (cause attached, abort → 'cancelled'). */ export declare function runLoaders(handlers: LoaderHandlers, records: readonly TableRecord[], location: RouteLocation, signal: AbortSignal): Promise>; /** Default affect policy: does a change in `keys` require this record's loader * to refetch? Prefix-handled (row-source) loaders receive the whole location, * so they depend on every declared query param plus `page`/`per_page`/`sort`; * URL templates depend only on the placeholders they mention. Override via * `LoaderHandlers.affects`. */ export declare function defaultAffects(record: TableRecord, keys: readonly string[], handlers: LoaderHandlers): boolean; //# sourceMappingURL=loaders.d.ts.map