import {Repository} from "./Repository"; import {getConnection} from "../index"; import {DeepPartial} from "../common/DeepPartial"; import {SaveOptions} from "./SaveOptions"; import {FindOneOptions} from "../find-options/FindOneOptions"; import {RemoveOptions} from "./RemoveOptions"; import {FindManyOptions} from "../find-options/FindManyOptions"; import {Connection} from "../connection/Connection"; import {ObjectType} from "../common/ObjectType"; import {SelectQueryBuilder} from "../query-builder/SelectQueryBuilder"; import {InsertResult} from "../query-builder/result/InsertResult"; import {UpdateResult} from "../query-builder/result/UpdateResult"; import {DeleteResult} from "../query-builder/result/DeleteResult"; import {ObjectID} from "../driver/mongodb/typings"; /** * Base abstract entity for all entities, used in ActiveRecord patterns. */ export class BaseEntity { // ------------------------------------------------------------------------- // Private Static Properties // ------------------------------------------------------------------------- /** * Connection used in all static methods of the BaseEntity. */ // @ts-ignore: Unused variable which is actually used private static usedConnection?: Connection; // ------------------------------------------------------------------------- // Public Methods // ------------------------------------------------------------------------- /** * Checks if entity has an id. * If entity composite compose ids, it will check them all. */ hasId(): boolean { return (this.constructor as any).getRepository().hasId(this); } /** * Saves current entity in the database. * If entity does not exist in the database then inserts, otherwise updates. */ save(): Promise { return (this.constructor as any).getRepository().save(this); } /** * Removes current entity from the database. */ remove(): Promise { return (this.constructor as any).getRepository().remove(this); } /** * Reloads entity data from the database. */ async reload(): Promise { const base: any = this.constructor; const newestEntity: BaseEntity = await base.getRepository().findOneOrFail(base.getId(this)); Object.assign(this, newestEntity); } // ------------------------------------------------------------------------- // Public Static Methods // ------------------------------------------------------------------------- /** * Sets connection to be used by entity. */ static useConnection(connection: Connection) { this.usedConnection = connection; } /** * Gets current entity's Repository. */ static getRepository(this: ObjectType): Repository { const connection: Connection = (this as any).usedConnection || getConnection(); return connection.getRepository(this); } /** * Returns object that is managed by this repository. * If this repository manages entity from schema, * then it returns a name of that schema instead. */ static get target(): Function|string { return this.getRepository().target; } /** * Checks entity has an id. * If entity composite compose ids, it will check them all. */ static hasId(entity: BaseEntity): boolean { return this.getRepository().hasId(entity); } /** * Gets entity mixed id. */ static getId(this: ObjectType, entity: T): any { return (this as any).getRepository().getId(entity); } /** * Creates a new query builder that can be used to build a sql query. */ static createQueryBuilder(this: ObjectType, alias?: string): SelectQueryBuilder { return (this as any).getRepository().createQueryBuilder(alias); } /** * Creates a new entity instance. */ static create(this: ObjectType): T; /** * Creates a new entities and copies all entity properties from given objects into their new entities. * Note that it copies only properties that present in entity schema. */ static create(this: ObjectType, entityLikeArray: DeepPartial[]): T; /** * Creates a new entity instance and copies all entity properties from this object into a new entity. * Note that it copies only properties that present in entity schema. */ static create(this: ObjectType, entityLike: DeepPartial): T; /** * Creates a new entity instance and copies all entity properties from this object into a new entity. * Note that it copies only properties that present in entity schema. */ static create(this: ObjectType, entityOrEntities?: any): T { return (this as any).getRepository().create(entityOrEntities); } /** * Merges multiple entities (or entity-like objects) into a given entity. */ static merge(this: ObjectType, mergeIntoEntity: T, ...entityLikes: DeepPartial[]): T { return (this as any).getRepository().merge(mergeIntoEntity, ...entityLikes); } /** * Creates a new entity from the given plan javascript object. If entity already exist in the database, then * it loads it (and everything related to it), replaces all values with the new ones from the given object * and returns this new entity. This new entity is actually a loaded from the db entity with all properties * replaced from the new object. * * Note that given entity-like object must have an entity id / primary key to find entity by. * Returns undefined if entity with given id was not found. */ static preload(this: ObjectType, entityLike: DeepPartial): Promise { return (this as any).getRepository().preload(entityLike); } /** * Saves all given entities in the database. * If entities do not exist in the database then inserts, otherwise updates. */ static save(this: ObjectType, entities: T[], options?: SaveOptions): Promise; /** * Saves a given entity in the database. * If entity does not exist in the database then inserts, otherwise updates. */ static save(this: ObjectType, entity: T, options?: SaveOptions): Promise; /** * Saves one or many given entities. */ static save(this: ObjectType, entityOrEntities: T|T[], options?: SaveOptions): Promise { return (this as any).getRepository().save(entityOrEntities as any, options); } /** * Removes a given entities from the database. */ static remove(this: ObjectType, entities: T[], options?: RemoveOptions): Promise; /** * Removes a given entity from the database. */ static remove(this: ObjectType, entity: T, options?: RemoveOptions): Promise; /** * Removes one or many given entities. */ static remove(this: ObjectType, entityOrEntities: T|T[], options?: RemoveOptions): Promise { return (this as any).getRepository().remove(entityOrEntities as any, options); } /** * Inserts a given entity into the database. * Unlike save method executes a primitive operation without cascades, relations and other operations included. * Executes fast and efficient INSERT query. * Does not check if entity exist in the database, so query will fail if duplicate entity is being inserted. */ static insert(this: ObjectType, entity: DeepPartial|DeepPartial[], options?: SaveOptions): Promise { return (this as any).getRepository().insert(entity, options); } /** * Updates entity partially. Entity can be found by a given conditions. * Unlike save method executes a primitive operation without cascades, relations and other operations included. * Executes fast and efficient UPDATE query. * Does not check if entity exist in the database. */ static update(this: ObjectType, criteria: string|string[]|number|number[]|Date|Date[]|ObjectID|ObjectID[]|DeepPartial, partialEntity: DeepPartial, options?: SaveOptions): Promise { return (this as any).getRepository().update(criteria, partialEntity, options); } /** * Deletes entities by a given criteria. * Unlike save method executes a primitive operation without cascades, relations and other operations included. * Executes fast and efficient DELETE query. * Does not check if entity exist in the database. */ static delete(this: ObjectType, criteria: string|string[]|number|number[]|Date|Date[]|ObjectID|ObjectID[]|DeepPartial, options?: RemoveOptions): Promise { return (this as any).getRepository().delete(criteria, options); } /** * Counts entities that match given options. */ static count(this: ObjectType, options?: FindManyOptions): Promise; /** * Counts entities that match given conditions. */ static count(this: ObjectType, conditions?: DeepPartial): Promise; /** * Counts entities that match given find options or conditions. */ static count(this: ObjectType, optionsOrConditions?: FindManyOptions|DeepPartial): Promise { return (this as any).getRepository().count(optionsOrConditions as any); } /** * Finds entities that match given options. */ static find(this: ObjectType, options?: FindManyOptions): Promise; /** * Finds entities that match given conditions. */ static find(this: ObjectType, conditions?: DeepPartial): Promise; /** * Finds entities that match given find options or conditions. */ static find(this: ObjectType, optionsOrConditions?: FindManyOptions|DeepPartial): Promise { return (this as any).getRepository().find(optionsOrConditions as any); } /** * Finds entities that match given find options. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). */ static findAndCount(this: ObjectType, options?: FindManyOptions): Promise<[ T[], number ]>; /** * Finds entities that match given conditions. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). */ static findAndCount(this: ObjectType, conditions?: DeepPartial): Promise<[ T[], number ]>; /** * Finds entities that match given find options or conditions. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). */ static findAndCount(this: ObjectType, optionsOrConditions?: FindManyOptions|DeepPartial): Promise<[ T[], number ]> { return (this as any).getRepository().findAndCount(optionsOrConditions as any); } /** * Finds entities by ids. * Optionally find options can be applied. */ static findByIds(this: ObjectType, ids: any[], options?: FindManyOptions): Promise; /** * Finds entities by ids. * Optionally conditions can be applied. */ static findByIds(this: ObjectType, ids: any[], conditions?: DeepPartial): Promise; /** * Finds entities by ids. * Optionally find options can be applied. */ static findByIds(this: ObjectType, ids: any[], optionsOrConditions?: FindManyOptions|DeepPartial): Promise { return (this as any).getRepository().findByIds(ids, optionsOrConditions as any); } /** * Finds first entity that matches given options. */ static findOne(this: ObjectType, id?: string|number|Date|ObjectID, options?: FindOneOptions): Promise; /** * Finds first entity that matches given options. */ static findOne(this: ObjectType, options?: FindOneOptions): Promise; /** * Finds first entity that matches given conditions. */ static findOne(this: ObjectType, conditions?: DeepPartial, options?: FindOneOptions): Promise; /** * Finds first entity that matches given conditions. */ static findOne(this: ObjectType, optionsOrConditions?: string|number|Date|ObjectID|FindOneOptions|DeepPartial, maybeOptions?: FindOneOptions): Promise { return (this as any).getRepository().findOne(optionsOrConditions as any, maybeOptions); } /** * Finds first entity that matches given options. */ static findOneOrFail(this: ObjectType, id?: string|number|Date|ObjectID, options?: FindOneOptions): Promise; /** * Finds first entity that matches given options. */ static findOneOrFail(this: ObjectType, options?: FindOneOptions): Promise; /** * Finds first entity that matches given conditions. */ static findOneOrFail(this: ObjectType, conditions?: DeepPartial, options?: FindOneOptions): Promise; /** * Finds first entity that matches given conditions. */ static findOneOrFail(this: ObjectType, optionsOrConditions?: string|number|Date|ObjectID|FindOneOptions|DeepPartial, maybeOptions?: FindOneOptions): Promise { return (this as any).getRepository().findOneOrFail(optionsOrConditions as any, maybeOptions); } /** * Executes a raw SQL query and returns a raw database results. * Raw query execution is supported only by relational databases (MongoDB is not supported). */ static query(this: ObjectType, query: string, parameters?: any[]): Promise { return (this as any).getRepository().query(query, parameters); } /** * Clears all the data from the given table/collection (truncates/drops it). */ static clear(this: ObjectType, ): Promise { return (this as any).getRepository().clear(); } }