/**
 * Allows diffing of arbitrary JSON objects.
 */
import type { Get, Paths } from 'type-fest';
export interface DefinitionDiffOperation<T = unknown> {
    type: 'add' | 'update' | 'remove';
    key: string;
    item: T;
}
declare abstract class DefinitionDiffField<T = unknown> {
    /**
     * The name of the field to be presented to the user.
     */
    readonly name: string;
    constructor(name: string);
    abstract diff(current: T, desired: T): DefinitionDiffOperation[];
    abstract apply(current: T, diff: DefinitionDiffOperation[]): T;
    /**
     * Returns the verb to be used in the UI to describe the action e.g. created or added.
     * @param isNew Whether the item is new.
     */
    abstract getActionVerb(isNew: boolean): string;
}
interface DefinitionDiffKeyedArrayFieldOptions {
    /**
     * Whether to allow removing items from the array.
     */
    allowRemove?: boolean;
    /**
     * Ignore fields that should be ignored when diffing. Defaults to `['id']`.
     */
    ignoreFields?: readonly string[];
}
/**
 * A field that is an array of objects with a unique key.
 */
export declare class DefinitionDiffKeyedArrayField<T extends Record<string, unknown>[]> extends DefinitionDiffField<T> {
    readonly getKey: (item: T[number]) => string;
    readonly options: DefinitionDiffKeyedArrayFieldOptions;
    constructor(name: string, getKey: (item: T[number]) => string, options?: DefinitionDiffKeyedArrayFieldOptions);
    diff(current: T | undefined, desired: T | undefined): DefinitionDiffOperation[];
    apply(current: T | undefined, diff: DefinitionDiffOperation[]): T;
    getActionVerb(isNew: boolean): string;
}
/**
 * A field that is a replacement for the entire object or array.
 */
export declare class DefinitionDiffReplacementField<T = unknown> extends DefinitionDiffField<T> {
    diff(current: T, desired: T): DefinitionDiffOperation[];
    apply(current: T, diff: DefinitionDiffOperation[]): T;
    getActionVerb(isNew: boolean): string;
}
/**
 * A field that ensures an array contains certain values.
 * This field type only adds items, never removes them.
 */
export declare class DefinitionDiffArrayIncludesField<T extends unknown[] = string[]> extends DefinitionDiffField<T> {
    private readonly getKey?;
    constructor(name: string, getKey?: (item: T[number]) => string);
    diff(current: T | undefined, desired: T | undefined): DefinitionDiffOperation[];
    apply(current: T | undefined, diff: DefinitionDiffOperation[]): T;
    getActionVerb(isNew: boolean): string;
}
type ConvertToTemplateString<T> = T extends number ? `${T}` : T;
export type DefinitionDiffConfig<T> = Partial<{
    [K in Paths<T, {
        maxRecursionDepth: 2;
    }>]: DefinitionDiffField<Exclude<Get<T, ConvertToTemplateString<K>>, undefined>>;
}>;
export type DefinitionDiffOutput<TConfiguration extends DefinitionDiffConfig<unknown>> = Partial<Record<keyof TConfiguration, DefinitionDiffOperation[]>>;
export declare function createDefinitionDiffConfig<TValue>(config: DefinitionDiffConfig<TValue>): DefinitionDiffConfig<TValue>;
type InferDefinitionDiffInputFromConfig<TConfig extends DefinitionDiffConfig<unknown>> = TConfig extends DefinitionDiffConfig<infer T> ? T : never;
/**
 * Creates a diff between two objects.
 */
export declare function createDefinitionDiff<TConfig extends DefinitionDiffConfig<unknown>>(current: InferDefinitionDiffInputFromConfig<TConfig>, desired: InferDefinitionDiffInputFromConfig<TConfig>, configuration: TConfig): DefinitionDiffOutput<TConfig> | undefined;
/**
 * Applies a diff to an object.
 */
export declare function applyDefinitionDiff<TInput, TConfig extends DefinitionDiffConfig<unknown>>(current: TInput, diff: DefinitionDiffOutput<TConfig>, configuration: TConfig): TInput;
export {};
//# sourceMappingURL=definition-diff.d.ts.map