mongodb-dynamic-api
Version:
Auto generated CRUD API for MongoDB using NestJS
61 lines (60 loc) • 4.05 kB
TypeScript
/// <reference types="mongoose/types/aggregate" />
/// <reference types="mongoose/types/callback" />
/// <reference types="mongoose/types/collection" />
/// <reference types="mongoose/types/connection" />
/// <reference types="mongoose/types/cursor" />
/// <reference types="mongoose/types/document" />
/// <reference types="mongoose/types/error" />
/// <reference types="mongoose/types/expressions" />
/// <reference types="mongoose/types/helpers" />
/// <reference types="mongoose/types/middlewares" />
/// <reference types="mongoose/types/indexes" />
/// <reference types="mongoose/types/models" />
/// <reference types="mongoose/types/mongooseoptions" />
/// <reference types="mongoose/types/pipelinestage" />
/// <reference types="mongoose/types/populate" />
/// <reference types="mongoose/types/query" />
/// <reference types="mongoose/types/schemaoptions" />
/// <reference types="mongoose/types/schematypes" />
/// <reference types="mongoose/types/session" />
/// <reference types="mongoose/types/types" />
/// <reference types="mongoose/types/utility" />
/// <reference types="mongoose/types/validation" />
/// <reference types="mongoose/types/virtuals" />
/// <reference types="mongoose/types/inferschematype" />
import { Type } from '@nestjs/common';
import { PipelineStage } from 'mongodb-pipeline-builder';
import { FilterQuery, Model, Schema, UpdateQuery, UpdateWithAggregationPipeline } from 'mongoose';
import { AbilityPredicate, AuthAbilityPredicate, DeleteResult, DynamicApiCallbackMethods, UpdateResult } from '../../interfaces';
import { BaseEntity } from '../../models';
import { DynamicApiResetPasswordOptions } from '../../modules';
export declare abstract class BaseService<Entity extends BaseEntity> {
protected readonly model: Model<Entity>;
protected user: unknown;
protected readonly entity: Type<Entity>;
protected readonly abilityPredicate: AbilityPredicate<Entity> | undefined;
protected readonly passwordField: keyof Entity | undefined;
protected readonly resetPasswordOptions: DynamicApiResetPasswordOptions<Entity> | undefined;
protected readonly callbackMethods: DynamicApiCallbackMethods;
private readonly baseServiceLogger;
protected constructor(model: Model<Entity>);
get isSoftDeletable(): boolean;
protected verifyArguments(...args: unknown[]): void;
protected aggregateDocumentsWithAbilityPredicate(pipeline: any[]): Promise<Entity[]>;
protected findManyDocumentsWithAbilityPredicate(conditions?: FilterQuery<Entity>): Promise<Entity[]>;
protected findOneDocumentWithAbilityPredicate(_id: string | Schema.Types.ObjectId | undefined, conditions?: FilterQuery<Entity>, authAbilityPredicate?: AuthAbilityPredicate<Entity>): Promise<Entity>;
protected aggregateDocuments<T>(entity: Type<T>, pipeline: PipelineStage[]): Promise<T[]>;
protected findManyDocuments<T>(entity: Type<T>, query: FilterQuery<T>): Promise<T[]>;
protected findOneDocument<T>(entity: Type<T>, query: FilterQuery<T>): Promise<T | undefined>;
protected createManyDocuments<T>(entity: Type<T>, data: Partial<T>[]): Promise<T[]>;
protected createOneDocument<T>(entity: Type<T>, data: Partial<T>): Promise<T>;
protected updateManyDocuments<T>(entity: Type<T>, query: FilterQuery<T>, update: UpdateQuery<T> | UpdateWithAggregationPipeline): Promise<UpdateResult>;
protected updateOneDocument<T>(entity: Type<T>, query: FilterQuery<T>, update: UpdateQuery<T> | UpdateWithAggregationPipeline): Promise<UpdateResult>;
protected deleteManyDocuments<T>(entity: Type<T>, ids: string[]): Promise<DeleteResult>;
protected deleteOneDocument<T>(entity: Type<T>, id: string): Promise<DeleteResult>;
protected buildInstance(document: Entity): Entity;
protected handleAbilityPredicate(document: Entity, authAbilityPredicate?: AuthAbilityPredicate<Entity>): void;
protected handleDuplicateKeyError(error: any, reThrow?: boolean): void;
protected handleMongoErrors(error: any, reThrow?: boolean): void;
protected handleDocumentNotFound(): void;
}