monguito/dist/repository.d.ts

MongoDB Abstract Repository implementation for Node.js

import { Optional } from 'typescript-optional';
import { Entity } from './util/entity';
import { DeleteByIdOptions, FindAllOptions, FindByIdOptions, FindOneOptions, SaveOptions } from './util/operation-options';
/**
 * Models an entity with partial content that specifies a Mongo `id` and (optionally) a Mongoose discriminator key.
 */
export type PartialEntityWithId<T extends Entity> = {
    id: string;
} & {
    __t?: string;
} & Partial<T>;
/**
 * Specifies a list of common database CRUD operations.
 */
export interface Repository<T extends Entity> {
    /**
     * Finds an entity by ID.
     * @param {string} id the ID of the entity.
     * @param {FindByIdOptions} options (optional) search operation options.
     * @returns {Promise<Optional<S>>} the entity or `null`.
     * @throws {IllegalArgumentException} if the given `id` is `undefined` or `null`.
     * @see {@link FindByIdOptions}
     */
    findById: <S extends T>(id: string, options?: FindByIdOptions) => Promise<Optional<S>>;
    /**
     * Finds an entity by some filters.
     * @param {FindOneOptions} options (optional) search operation options.
     * @returns {Promise<Optional<S>>} the entity or `null`. If no `option.filters` is specified,
     * an arbitrary entity is returned.
     * @see {@link FindOneOptions}
     */
    findOne: <S extends T>(options?: FindOneOptions<S>) => Promise<Optional<S>>;
    /**
     * Finds all entities.
     * @param {FindAllOptions} options (optional) search operation options.
     * @returns {Promise<S[]>} all entities.
     * @throws {IllegalArgumentException} if the given `options` specifies an invalid parameter.
     * @see {@link FindAllOptions}
     */
    findAll: <S extends T>(options?: FindAllOptions<S>) => Promise<S[]>;
    /**
     * Saves (insert or update) an entity.
     * @param {S | PartialEntityWithId<S>} entity the entity to save.
     * @param {SaveOptions} options (optional) save operation options.
     * @returns {Promise<S>} the saved entity.
     * @throws {IllegalArgumentException} if the given entity is `undefined` or `null` or
     * (when update) specifies an `id` not matching any existing entity.
     * @throws {ValidationException} if the given entity specifies a field with some invalid value.
     * @see {@link SaveOptions}
     */
    save: <S extends T>(entity: S | PartialEntityWithId<S>, options?: SaveOptions) => Promise<S>;
    /**
     * Deletes an entity by ID.
     * @param {string} id the ID of the entity.
     * @param {DeleteByIdOptions} options (optional) delete operation options.
     * @returns {Promise<boolean>} `true` if the entity was deleted, `false` otherwise.
     * @throws {IllegalArgumentException} if the given `id` is `undefined` or `null`.
     * @see {@link DeleteByIdOptions}
     */
    deleteById: (id: string, options?: DeleteByIdOptions) => Promise<boolean>;
}