Class BaseUser

The User Entity is a data schema that represents a user within your application. It typically includes fields such as the user's name, email address, password, and other profile information.

Hierarchy

  • BaseEntity
    • BaseUser

Implements

Constructors

constructor

Properties

avatarUrl? clientId? createdAt deletedAt? email firstName id invitationStatus invitationStatusChanges is2faEnabled? isOtpEnabled? lastName lastSeen locale? otpSecret? parentUserId? passwordHash? patronymic? permissions phoneNumber? referrer? resolvedPermissions status timezoneName? type updatedAt userToRoles

Accessors

fullName isDeleted target

Methods

hasId recover reload remove save softRemove average clear count countBy create createQueryBuilder delete exists existsBy find findAndCount findAndCountBy findBy findByIds findOne findOneBy findOneById findOneByOrFail findOneOrFail getId getRepository hasId insert maximum merge minimum preload query remove save softRemove sum update upsert useDataSource

Constructors

constructor

Properties

OptionalavatarUrl

avatarUrl?: MaybeNull<string>

User's avatar URL

Example

'https://example.com/avatar.png'

OptionalclientId

clientId?: MaybeNull<string>

Client ID (for Apollo Studio)

createdAt

createdAt: Date

Date, when user was created.

OptionaldeletedAt

deletedAt?: MaybeNull<Date>

Date, when user was deleted.

email

email: string

Users's email. Must be unique.

Example

'[email protected]'

firstName

firstName: string

User's first name

Example

'John'

id

id: string

invitationStatus

invitationStatus: UserInvitationStatus

When user is invited to the system, it has one of the following statuses:

See

invitationStatusChanges

invitationStatusChanges: Promise<InvitationStatusChange[]>

Optionalis2faEnabled

is2faEnabled?: MaybeNull<boolean>

Represent Two-Factor Authentication status.

OptionalisOtpEnabled

isOtpEnabled?: MaybeNull<boolean>

Represent One-Time Password status.

lastName

lastName: string

User's last name

Example

'Doe'

lastSeen

lastSeen: Date

Date, when user made last request to the system.

Optionallocale

locale?: MaybeNull<string>

User's locale in ISO 639-1 format. Use LanguagesModule to fetch lists with locales.

Example

'en'

OptionalotpSecret

otpSecret?: MaybeNull<string>

Keep One-Time Password secret.

OptionalparentUserId

parentUserId?: MaybeNull<string>

Parent user who was signed in as this user.

OptionalpasswordHash

passwordHash?: MaybeNull<string>

User's password hash. Generated from real password by bcrypt. When user logged in with password, password hash is compared with this field.

Optionalpatronymic

patronymic?: MaybeNull<string>

User's patronymic name

Example

'Ivanovich'

permissions

permissions: string[] = []

User's custom permissions. In general, permissions must be inherited from roles. But you can add custom permissions to user.

Example

[
 'js:core:episodes:create',
 'js:core:episodes:update'
]

OptionalphoneNumber

phoneNumber?: MaybeNull<string>

User's phone number

Example

'+380501234567'

Optionalreferrer

referrer?: MaybeNull<string>

User's referrer. It can be email or any other identifier.

Example

'[email protected]'

resolvedPermissions

resolvedPermissions: ReadonlyResolvedPermission[] = []

User's resolved permissions. This array is used by authorization guards to check user's permissions. This array must be fullfilled by UserManager.resolve when user tries to make request.

Example

[
 {
   id: 'js:core:episodes:create',
   scopes: ['org#hcorg:xxxxxxxxxx']
 },
 ...
]

status

status: UserStatus

Users has two statuses: ACTIVE and DELETED.

ACTIVE - user is active and can signin to the system. DELETED - user is deleted and can't signin to the system.

See

OptionaltimezoneName

timezoneName?: MaybeNull<string>

User's timezone name in IANA format. Use TimezonesModule to fetch lists with timezones.

Example

'Europe/Kiev'

type

type: UserType

Users has two types: USER and SA.

See

updatedAt

updatedAt: Date

Date, when user was updated.

userToRoles

userToRoles: Promise<BaseUserToRole[]>

User's roles.

Accessors

fullName

  • get fullName(): string

    User's full name computed from first and last name

    Returns string

    Example

    'John Doe'

isDeleted

  • get isDeleted(): boolean

    Returns boolean

Statictarget

  • get target(): EntityTarget<any>

    Returns object that is managed by this repository. If this repository manages entity from schema, then it returns a name of that schema instead.

    Returns EntityTarget<any>

Methods

hasId

  • hasId(): boolean

    Checks if entity has an id. If entity composite compose ids, it will check them all.

    Returns boolean

recover

  • recover(options?: SaveOptions): Promise<BaseUser>

    Recovers a given entity in the database.

    Parameters

    • Optionaloptions: SaveOptions

    Returns Promise<BaseUser>

reload

  • reload(): Promise<void>

    Reloads entity data from the database.

    Returns Promise<void>

remove

  • remove(options?: RemoveOptions): Promise<BaseUser>

    Removes current entity from the database.

    Parameters

    • Optionaloptions: RemoveOptions

    Returns Promise<BaseUser>

save

  • save(options?: SaveOptions): Promise<BaseUser>

    Saves current entity in the database. If entity does not exist in the database then inserts, otherwise updates.

    Parameters

    • Optionaloptions: SaveOptions

    Returns Promise<BaseUser>

softRemove

  • softRemove(options?: SaveOptions): Promise<BaseUser>

    Records the delete date of current entity.

    Parameters

    • Optionaloptions: SaveOptions

    Returns Promise<BaseUser>

Staticaverage

  • average<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        columnName: PickKeysByType<T, number>,
        where: FindOptionsWhere<T>,
    ): Promise<null | number>

    Return the AVG of a column

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • columnName: PickKeysByType<T, number>
    • where: FindOptionsWhere<T>

    Returns Promise<null | number>

Staticclear

  • clear<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
    ): Promise<void>

    Clears all the data from the given table/collection (truncates/drops it).

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity

    Returns Promise<void>

Staticcount

  • count<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        options?: FindManyOptions<T>,
    ): Promise<number>

    Counts entities that match given options.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • Optionaloptions: FindManyOptions<T>

    Returns Promise<number>

StaticcountBy

  • countBy<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        where: FindOptionsWhere<T>,
    ): Promise<number>

    Counts entities that match given WHERE conditions.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<number>

Staticcreate

  • create<T extends BaseEntity>(this: new () => T & typeof BaseEntity): T

    Creates a new entity instance.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity

    Returns T

  • create<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entityLikeArray: DeepPartial<T>[],
    ): 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.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entityLikeArray: DeepPartial<T>[]

    Returns T[]

  • create<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entityLike: DeepPartial<T>,
    ): 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.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entityLike: DeepPartial<T>

    Returns T

StaticcreateQueryBuilder

  • createQueryBuilder<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        alias?: string,
    ): SelectQueryBuilder<T>

    Creates a new query builder that can be used to build a SQL query.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • Optionalalias: string

    Returns SelectQueryBuilder<T>

Staticdelete

  • delete<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        criteria:
            | string
            | number
            | string[]
            | Date
            | ObjectId
            | number[]
            | Date[]
            | ObjectId[]
            | FindOptionsWhere<T>,
    ): Promise<DeleteResult>

    Deletes entities by a given criteria. Unlike remove 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.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • criteria:
          | string
          | number
          | string[]
          | Date
          | ObjectId
          | number[]
          | Date[]
          | ObjectId[]
          | FindOptionsWhere<T>

    Returns Promise<DeleteResult>

Staticexists

  • exists<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        options?: FindManyOptions<T>,
    ): Promise<boolean>

    Checks whether any entity exists that matches the given options.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • Optionaloptions: FindManyOptions<T>

    Returns Promise<boolean>

StaticexistsBy

  • existsBy<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        where: FindOptionsWhere<T>,
    ): Promise<boolean>

    Checks whether any entity exists that matches the given conditions.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<boolean>

Staticfind

  • find<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        options?: FindManyOptions<T>,
    ): Promise<T[]>

    Finds entities that match given options.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • Optionaloptions: FindManyOptions<T>

    Returns Promise<T[]>

StaticfindAndCount

  • findAndCount<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        options?: FindManyOptions<T>,
    ): Promise<[T[], number]>

    Finds entities that match given find options. Also counts all entities that match given conditions, but ignores pagination settings (from and take options).

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • Optionaloptions: FindManyOptions<T>

    Returns Promise<[T[], number]>

StaticfindAndCountBy

  • findAndCountBy<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        where: FindOptionsWhere<T>,
    ): Promise<[T[], number]>

    Finds entities that match given WHERE conditions. Also counts all entities that match given conditions, but ignores pagination settings (from and take options).

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<[T[], number]>

StaticfindBy

  • findBy<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        where: FindOptionsWhere<T>,
    ): Promise<T[]>

    Finds entities that match given WHERE conditions.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<T[]>

StaticfindByIds

  • findByIds<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        ids: any[],
    ): Promise<T[]>

    Finds entities by ids. Optionally find options can be applied.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • ids: any[]

    Returns Promise<T[]>

    Deprecated

    use findBy method instead in conjunction with In operator, for example:

    .findBy({ id: In([1, 2, 3]) })

StaticfindOne

  • findOne<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        options: FindOneOptions<T>,
    ): Promise<null | T>

    Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • options: FindOneOptions<T>

    Returns Promise<null | T>

StaticfindOneBy

  • findOneBy<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        where: FindOptionsWhere<T>,
    ): Promise<null | T>

    Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<null | T>

StaticfindOneById

  • findOneById<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        id: string | number | Date | ObjectId,
    ): Promise<null | T>

    Finds first entity that matches given options.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • id: string | number | Date | ObjectId

    Returns Promise<null | T>

    Deprecated

    use findOneBy method instead in conjunction with In operator, for example:

    .findOneBy({ id: 1 // where "id" is your primary column name })

StaticfindOneByOrFail

  • findOneByOrFail<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        where: FindOptionsWhere<T>,
    ): Promise<T>

    Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<T>

StaticfindOneOrFail

  • findOneOrFail<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        options: FindOneOptions<T>,
    ): Promise<T>

    Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • options: FindOneOptions<T>

    Returns Promise<T>

StaticgetId

  • getId<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entity: T,
    ): any

    Gets entity mixed id.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entity: T

    Returns any

StaticgetRepository

  • getRepository<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
    ): Repository<T>

    Gets current entity's Repository.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity

    Returns Repository<T>

StatichasId

  • hasId(entity: BaseEntity): boolean

    Checks entity has an id. If entity composite compose ids, it will check them all.

    Parameters

    • entity: BaseEntity

    Returns boolean

Staticinsert

  • insert<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entity:
            | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
            | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[],
    ): Promise<InsertResult>

    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.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entity:
          | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
          | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[]

    Returns Promise<InsertResult>

Staticmaximum

  • maximum<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        columnName: PickKeysByType<T, number>,
        where: FindOptionsWhere<T>,
    ): Promise<null | number>

    Return the MAX of a column

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • columnName: PickKeysByType<T, number>
    • where: FindOptionsWhere<T>

    Returns Promise<null | number>

Staticmerge

  • merge<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        mergeIntoEntity: T,
        ...entityLikes: DeepPartial<T>[],
    ): T

    Merges multiple entities (or entity-like objects) into a given entity.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • mergeIntoEntity: T
    • ...entityLikes: DeepPartial<T>[]

    Returns T

Staticminimum

  • minimum<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        columnName: PickKeysByType<T, number>,
        where: FindOptionsWhere<T>,
    ): Promise<null | number>

    Return the MIN of a column

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • columnName: PickKeysByType<T, number>
    • where: FindOptionsWhere<T>

    Returns Promise<null | number>

Staticpreload

  • preload<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entityLike: DeepPartial<T>,
    ): Promise<undefined | T>

    Creates a new entity from the given plain 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.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entityLike: DeepPartial<T>

    Returns Promise<undefined | T>

Staticquery

  • query<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        query: string,
        parameters?: any[],
    ): Promise<any>

    Executes a raw SQL query and returns a raw database results. Raw query execution is supported only by relational databases (MongoDB is not supported).

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • query: string
    • Optionalparameters: any[]

    Returns Promise<any>

Staticremove

  • remove<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entities: T[],
        options?: RemoveOptions,
    ): Promise<T[]>

    Removes a given entities from the database.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entities: T[]
    • Optionaloptions: RemoveOptions

    Returns Promise<T[]>

  • remove<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entity: T,
        options?: RemoveOptions,
    ): Promise<T>

    Removes a given entity from the database.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entity: T
    • Optionaloptions: RemoveOptions

    Returns Promise<T>

Staticsave

  • save<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entities: DeepPartial<T>[],
        options?: SaveOptions,
    ): Promise<T[]>

    Saves all given entities in the database. If entities do not exist in the database then inserts, otherwise updates.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entities: DeepPartial<T>[]
    • Optionaloptions: SaveOptions

    Returns Promise<T[]>

  • save<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entity: DeepPartial<T>,
        options?: SaveOptions,
    ): Promise<T>

    Saves a given entity in the database. If entity does not exist in the database then inserts, otherwise updates.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entity: DeepPartial<T>
    • Optionaloptions: SaveOptions

    Returns Promise<T>

StaticsoftRemove

  • softRemove<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entities: T[],
        options?: SaveOptions,
    ): Promise<T[]>

    Records the delete date of all given entities.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entities: T[]
    • Optionaloptions: SaveOptions

    Returns Promise<T[]>

  • softRemove<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entity: T,
        options?: SaveOptions,
    ): Promise<T>

    Records the delete date of a given entity.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entity: T
    • Optionaloptions: SaveOptions

    Returns Promise<T>

Staticsum

  • sum<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        columnName: PickKeysByType<T, number>,
        where: FindOptionsWhere<T>,
    ): Promise<null | number>

    Return the SUM of a column

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • columnName: PickKeysByType<T, number>
    • where: FindOptionsWhere<T>

    Returns Promise<null | number>

Staticupdate

  • update<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        criteria:
            | string
            | number
            | string[]
            | Date
            | ObjectId
            | number[]
            | Date[]
            | ObjectId[]
            | FindOptionsWhere<T>,
        partialEntity: _QueryDeepPartialEntity<
            ObjectLiteral extends T ? unknown : T,
        >,
    ): Promise<UpdateResult>

    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.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • criteria:
          | string
          | number
          | string[]
          | Date
          | ObjectId
          | number[]
          | Date[]
          | ObjectId[]
          | FindOptionsWhere<T>
    • partialEntity: _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>

    Returns Promise<UpdateResult>

Staticupsert

  • upsert<T extends BaseEntity>(
        this: new () => T & typeof BaseEntity,
        entityOrEntities:
            | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
            | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[],
        conflictPathsOrOptions: string[] | UpsertOptions<T>,
    ): Promise<InsertResult>

    Inserts a given entity into the database, unless a unique constraint conflicts then updates the entity Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient INSERT ... ON CONFLICT DO UPDATE/ON DUPLICATE KEY UPDATE query.

    Type Parameters

    • T extends BaseEntity

    Parameters

    • this: new () => T & typeof BaseEntity
    • entityOrEntities:
          | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
          | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[]
    • conflictPathsOrOptions: string[] | UpsertOptions<T>

    Returns Promise<InsertResult>

StaticuseDataSource

  • useDataSource(dataSource: null | DataSource): void

    Sets DataSource to be used by entity.

    Parameters

    • dataSource: null | DataSource

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods