import ModelCollection from './ModelCollection';
import type Model from './Model';
import type { MaybeArray } from '../Support/type';
type Ancestralised<T extends Model, CT extends string = 'children'> = T & {
    [key in CT]: ModelCollection<Ancestralised<T, CT>>;
};
export default class AncestryCollection<T extends Model, CT extends string = 'children'> extends ModelCollection<Ancestralised<T, CT>> {
    /**
     * The name of the key that will be set when arranging the items in a tree structure.
     */
    static depthName: string;
    /**
     * The name of the attribute that includes the related models.
     *
     * @protected
     */
    protected childrenRelation: CT;
    /**
     * @param models - The models already arranged in an ancestry tree format.
     * @param childrenRelation - The key that will include descendants.
     *
     */
    protected constructor(models?: MaybeArray<Ancestralised<T, CT>>, childrenRelation?: CT);
    /**
     * Arrange the items in an ancestry tree format.
     *
     * @param models - The ModelCollection to sort.
     * @param parentKey - The key that identifies the parent's id.
     * @param childrenRelation - The key that will include descendants.
     *
     * @return {AncestryCollection}
     */
    static treeOf<ST extends Model, CT extends string = 'children'>(models: ModelCollection<ST> | ST[], parentKey?: string, childrenRelation?: CT): AncestryCollection<ST, CT>;
    /**
     * Return all the models in a single level with no children set.
     *
     * @return {ModelCollection}
     */
    flatten(): ModelCollection<T>;
    /**
     * All the models that do not have any children.
     *
     * @return {ModelCollection}
     */
    leaves(): ModelCollection<T>;
    /**
     * Asserts whether the given value
     * is an instance of AncestryCollection.
     *
     * @param value
     *
     * @return {boolean}
     */
    static isAncestryCollection<M extends Model>(value: any): value is AncestryCollection<M>;
}
export {};
//# sourceMappingURL=AncestryCollection.d.ts.map