@sourceloop/core / Exports / TenantGuardService

Class: TenantGuardService<T, ID>¶

Type parameters¶

Name	Type
`T`	extends `EntityWithTenantId`
`ID`	`ID`

Implements¶

ITenantGuard<T, ID>

Table of contents¶

Constructors¶

constructor

Properties¶

Methods¶

Constructors¶

constructor¶

• new TenantGuardService<T, ID>(getCurrentUser, config?)

Type parameters¶

Name	Type
`T`	extends `Entity`<`T`> & { `tenantId`: `string` }
`ID`	`ID`

Parameters¶

Name	Type
`getCurrentUser`	`Getter`<`UserInToken`>
`config?`	`ITenantUtilitiesConfig`

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:27

Properties¶

config¶

• Private Optional Readonly config: ITenantUtilitiesConfig

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:31

getCurrentUser¶

• Readonly getCurrentUser: Getter<UserInToken>

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:29

Methods¶

addTenantIDMultiple¶

▸ Private addTenantIDMultiple<R>(entities): Promise<R[]>

Type parameters¶

Name	Type
`R`	extends `EntityWithTenantId` \| `Partial`<`T`> \|

Parameters¶

Name	Type
`entities`	`R`[]

Returns¶

Promise<R[]>

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:150

addTenantId¶

▸ Private addTenantId<S>(entity): Promise<S>

Type parameters¶

Name	Type
`S`	extends `EntityWithTenantId` \| `Partial`<`T`> \|

Parameters¶

Name	Type
`entity`	`S`

Returns¶

Promise<S>

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:141

addTenantToFilter¶

▸ Private addTenantToFilter(filter?, id?): Promise<Filter<T>>

Parameters¶

Name	Type
`filter?`	`Filter`<`T`>
`id?`	`ID`

Returns¶

Promise<Filter<T>>

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:179

addTenantToWhere¶

▸ Private addTenantToWhere(where?, id?): Promise<Where<T>>

Parameters¶

Name	Type
`where?`	`Where`<`T`>
`id?`	`ID`

Returns¶

Promise<Where<T>>

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:172

buildWhere¶

▸ buildWhere(user, where?, id?): Where<T>

Parameters¶

Name	Type
`user`	`UserInToken`
`where?`	`Where`<`T`>
`id?`	`ID`

Returns¶

Where<T>

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:193

checkTenantId¶

▸ Private checkTenantId(data): Promise<void>

Parameters¶

Name	Type
`data`	`DataObject`<`T`>

Returns¶

Promise<void>

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:127

count¶

▸ count(where?): Promise<Where<T>>

Parameters¶

Name	Type
`where?`	`Where`<`T`>

Returns¶

Promise<Where<T>>

Implementation of¶

ITenantGuard.count

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:54

create¶

▸ create(data): Promise<DataObject<T>>

Parameters¶

Name	Type
`data`	`DataObject`<`T`>

Returns¶

Promise<DataObject<T>>

Implementation of¶

ITenantGuard.create

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:62

createAll¶

▸ createAll<R>(data): Promise<R[]>

Type parameters¶

Name	Type
`R`	extends `EntityWithTenantId` \| `Partial`<`T`> \|

Parameters¶

Name	Type
`data`	`R`[]

Returns¶

Promise<R[]>

Implementation of¶

ITenantGuard.createAll

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:66

delete¶

▸ delete(entity): Promise<{ entity: T ; where: Where<T> }>

Parameters¶

Name	Type
`entity`	`T`

Returns¶

Promise<{ entity: T ; where: Where<T> }>

Implementation of¶

ITenantGuard.delete

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:115

deleteAll¶

▸ deleteAll(where?): Promise<Where<T>>

Parameters¶

Name	Type
`where?`	`Where`<`T`>

Returns¶

Promise<Where<T>>

Implementation of¶

ITenantGuard.deleteAll

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:123

deleteById¶

▸ deleteById(id): Promise<Where<T>>

Parameters¶

Name	Type
`id`	`ID`

Returns¶

Promise<Where<T>>

Implementation of¶

ITenantGuard.deleteById

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:111

exists¶

▸ exists(id): Promise<Where<T>>

Parameters¶

Name	Type
`id`	`ID`

Returns¶

Promise<Where<T>>

Implementation of¶

ITenantGuard.exists

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:58

find¶

▸ find(filter?): Promise<Filter<T>>

Parameters¶

Name	Type
`filter?`	`Filter`<`T`>

Returns¶

Promise<Filter<T>>

Implementation of¶

ITenantGuard.find

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:42

findById¶

▸ findById(id, filter?): Promise<Filter<T>>

Parameters¶

Name	Type
`id`	`ID`
`filter?`	`FilterExcludingWhere`<`T`>

Returns¶

Promise<Filter<T>>

Implementation of¶

ITenantGuard.findById

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:50

findOne¶

▸ findOne(filter?): Promise<Filter<T>>

Parameters¶

Name	Type
`filter?`	`Filter`<`T`>

Returns¶

Promise<Filter<T>>

Implementation of¶

ITenantGuard.findOne

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:46

replaceById¶

▸ replaceById(id, data): Promise<{ data: DataObject<T> ; where: Where<T> }>

Parameters¶

Name	Type
`id`	`ID`
`data`	`DataObject`<`T`>

Returns¶

Promise<{ data: DataObject<T> ; where: Where<T> }>

Implementation of¶

ITenantGuard.replaceById

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:74

save¶

▸ save(entity): Promise<T>

Parameters¶

Name	Type
`entity`	`T`

Returns¶

Promise<T>

Implementation of¶

ITenantGuard.save

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:70

skipTenantGuard¶

▸ skipTenantGuard(): Promise<boolean>

Returns¶

Promise<boolean>

Implementation of¶

ITenantGuard.skipTenantGuard

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:34

update¶

▸ update(data): Promise<{ data: T ; where: Where<T> }>

Parameters¶

Name	Type
`data`	`T`

Returns¶

Promise<{ data: T ; where: Where<T> }>

Implementation of¶

ITenantGuard.update

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:92

updateAll¶

▸ updateAll(data, where?): Promise<{ data: DataObject<T> ; where: Where<T> }>

Parameters¶

Name	Type
`data`	`DataObject`<`T`>
`where?`	`Where`<`T`>

Returns¶

Promise<{ data: DataObject<T> ; where: Where<T> }>

Implementation of¶

ITenantGuard.updateAll

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:100

updateById¶

▸ updateById<R>(id, data): Promise<{ data: R ; where: Where<T> }>

Type parameters¶

Name	Type
`R`	extends `EntityWithTenantId` \| `Partial`<`T`> \|

Parameters¶

Name	Type
`id`	`ID`
`data`	`R`

Returns¶

Promise<{ data: R ; where: Where<T> }>

Implementation of¶

ITenantGuard.updateById

Defined in¶

packages/core/src/components/tenant-utilities/services/tenant-guard.service.ts:81