import * as t from '../retype/retype';
/**
 * Spiffy is our utility for Schematized Persisted Files
 * Pretty simple: we use Retype to define a schema which parsed JSON is validated against
 */
export declare function spiffy<TSpfData>(template: TSpfTemplate<TSpfData>): TSpfFactory<TSpfData>;
type TDefaultFileLocation = {
    relativePath: string;
    relativeTo: 'USER_HOME' | 'REPO';
};
type TSpfMutator<TSpfData> = (data: TSpfData) => void;
type TSpfTemplate<TSpfData> = {
    defaultLocations: TDefaultFileLocation[];
    schema: t.Schema<TSpfData>;
    initialize: () => unknown;
    options?: {
        removeIfEmpty?: boolean;
        removeIfInvalid?: boolean;
    };
};
type TSpfInstance<TSpfData> = {
    readonly data: TSpfData;
    readonly update: (mutator: TSpfMutator<TSpfData>) => void;
    readonly path: string;
    delete: () => void;
};
type TSpfFactory<TSpfData> = {
    load: (filePath?: string) => TSpfInstance<TSpfData>;
    loadIfExists: (filePath?: string) => TSpfInstance<TSpfData> | undefined;
};
export {};