import { TypeMetadata } from '@dipscope/type-manager';
import { IncludeBrowseCommandBuilder } from './command-builders/include-browse-command-builder';
import { RootBrowseCommandBuilder } from './command-builders/root-browse-command-builder';
import { SortBrowseCommandBuilder } from './command-builders/sort-browse-command-builder';
import { Entity } from './entity';
import { EntityCollection } from './entity-collection';
import { EntityCollectionLike } from './entity-collection-like';
import { EntityProvider } from './entity-provider';
import { FilterClause } from './filter-clause';
import { IncludeClause, IncludeCollectionClause } from './include-clause';
import { KeyValue } from './key-value';
import { Nullable } from './nullable';
import { PaginateClause } from './paginate-clause';
import { PaginatedEntityCollection } from './paginated-entity-collection';
import { SortClause } from './sort-clause';
/**
 * Entity set which allows manipulations over a certain entity type.
 *
 * @type {EntitySet<TEntity>}
 */
export declare class EntitySet<TEntity extends Entity> {
    /**
     * Entity type metadata.
     *
     * @type {TypeMetadata<TEntity>}
     */
    readonly typeMetadata: TypeMetadata<TEntity>;
    /**
     * Entity provider.
     *
     * @type {EntityProvider}
     */
    readonly entityProvider: EntityProvider;
    /**
     * Constructor.
     *
     * @param {TypeMetadata<TEntity>} typeMetadata Entity type metadata.
     * @param {EntityProvider} entityProvider Entity provider.
     */
    constructor(typeMetadata: TypeMetadata<TEntity>, entityProvider: EntityProvider);
    /**
     * Filters entity set.
     *
     * @param {FilterClause<TEntity>} filterClause Filter clause.
     *
     * @returns {RootBrowseCommandBuilder<TEntity>} Root browse command builder.
     */
    filter(filterClause: FilterClause<TEntity>): RootBrowseCommandBuilder<TEntity>;
    /**
     * Sorts entity set in ascending order.
     *
     * @param {SortClause<TEntity, TProperty>} sortClause Sort clause.
     *
     * @returns {SortBrowseCommandBuilder<TEntity>} Sort browse command builder.
     */
    sortByAsc<TProperty>(sortClause: SortClause<TEntity, TProperty>): SortBrowseCommandBuilder<TEntity>;
    /**
     * Sorts entity set in descending order.
     *
     * @param {SortClause<TEntity, TProperty>} sortClause Sort clause.
     *
     * @returns {SortBrowseCommandBuilder<TEntity>} Sort browse command builder.
     */
    sortByDesc<TProperty>(sortClause: SortClause<TEntity, TProperty>): SortBrowseCommandBuilder<TEntity>;
    /**
     * Includes entity for eager loading.
     *
     * @param {IncludeClause<TEntity, TProperty>} includeClause Include clause.
     *
     * @returns {IncludeBrowseCommandBuilder<TEntity, TProperty>} Include browse command builder.
     */
    include<TProperty extends Entity>(includeClause: IncludeClause<TEntity, TProperty>): IncludeBrowseCommandBuilder<TEntity, TProperty>;
    /**
     * Includes entity collection for eager loading.
     *
     * @param {IncludeCollectionClause<TEntity, TProperty>} includeCollectionClause Include collection clause.
     *
     * @returns {IncludeBrowseCommandBuilder<TEntity, TProperty>} Include browse command builder.
     */
    includeCollection<TProperty extends Entity>(includeCollectionClause: IncludeCollectionClause<TEntity, TProperty>): IncludeBrowseCommandBuilder<TEntity, TProperty>;
    /**
     * Paginates entity set.
     *
     * @param {PaginateClause<TEntity>} paginateClause Paginate clause.
     *
     * @returns {RootBrowseCommandBuilder<TEntity>} Root browse command builder.
     */
    paginate(paginateClause: PaginateClause<TEntity>): RootBrowseCommandBuilder<TEntity>;
    /**
     * Finds all entities in a set.
     *
     * @returns {Promise<PaginatedEntityCollection<TEntity>>} Paginated entity collection.
     */
    findAll(): Promise<PaginatedEntityCollection<TEntity>>;
    /**
     * Finds one entity in a set.
     *
     * @returns {Promise<Nullable<TEntity>>} Entity or null.
     */
    findOne(): Promise<Nullable<TEntity>>;
    /**
     * Finds one entity in a set or throws an exception.
     *
     * @returns {Promise<TEntity>} Entity or error.
     */
    findOneOrFail(): Promise<TEntity>;
    /**
     * Finds entity by key values.
     *
     * @param {ReadonlyArray<KeyValue>} keyValues Readonly array of key values.
     *
     * @returns {Promise<Nullable<TEntity>>} Entity or null when entity not found.
     */
    find(...keyValues: ReadonlyArray<KeyValue>): Promise<Nullable<TEntity>>;
    /**
     * Finds entity by key values or throws an error.
     *
     * @param {ReadonlyArray<KeyValue>} keyValues Readonly array of key values.
     *
     * @returns {Promise<TEntity>} Entity or error.
     */
    findOrFail(...keyValues: ReadonlyArray<KeyValue>): Promise<TEntity>;
    /**
     * Adds an entity.
     *
     * @param {TEntity} entity Entity which should be added.
     *
     * @returns {Promise<TEntity>} Added entity.
     */
    add(entity: TEntity): Promise<TEntity>;
    /**
     * Bulk adds an entity collection.
     *
     * @param {EntityCollectionLike<TEntity>} entityCollectionLike Entity collection like which should be added.
     *
     * @returns {Promise<EntityCollection<TEntity>>} Added entity collection.
     */
    bulkAdd(entityCollectionLike: EntityCollectionLike<TEntity>): Promise<EntityCollection<TEntity>>;
    /**
     * Updates an entity.
     *
     * @param {TEntity} entity Entity which should be updated.
     *
     * @returns {Promise<TEntity>} Updated entity.
     */
    update(entity: TEntity): Promise<TEntity>;
    /**
     * Bulk updates an entity collection.
     *
     * @param {EntityCollectionLike<TEntity>} entityCollectionLike Entity collection like which should be updated.
     *
     * @returns {Promise<EntityCollection<TEntity>>} Added entity collection.
     */
    bulkUpdate(entityCollectionLike: EntityCollectionLike<TEntity>): Promise<EntityCollection<TEntity>>;
    /**
     * Batch updates an entity collection.
     *
     * @param {Partial<TEntity>} entityPartial Entity partial.
     *
     * @returns {Promise<void>} Batch update promise.
     */
    batchUpdate(entityPartial: Partial<TEntity>): Promise<void>;
    /**
     * Saves an entity.
     *
     * @param {TEntity} entity Entity which should be saved.
     *
     * @returns {Promise<TEntity>} Saved entity.
     */
    save(entity: TEntity): Promise<TEntity>;
    /**
     * Bulk saves an entity collection.
     *
     * @param {EntityCollectionLike<TEntity>} entityCollectionLike Entity collection like which should be saved.
     *
     * @returns {Promise<EntityCollection<TEntity>>} Saved entity collection.
     */
    bulkSave(entityCollectionLike: EntityCollectionLike<TEntity>): Promise<EntityCollection<TEntity>>;
    /**
     * Removes an entity.
     *
     * @param {TEntity} entity Entity which should be removed.
     *
     * @returns {Promise<TEntity>} Removed entity.
     */
    remove(entity: TEntity): Promise<TEntity>;
    /**
     * Bulk removes an entity collection.
     *
     * @param {EntityCollectionLike<TEntity>} entityCollectionLike Entity collection like which should be removed.
     *
     * @returns {Promise<EntityCollection<TEntity>>} Removed entity collection.
     */
    bulkRemove(entityCollectionLike: EntityCollectionLike<TEntity>): Promise<EntityCollection<TEntity>>;
    /**
     * Batch removes an entity collection.
     *
     * @returns {Promise<void>} Batch remove promise.
     */
    batchRemove(): Promise<void>;
}
//# sourceMappingURL=entity-set.d.ts.map