Class SoftDeleteRepository<T, CreateData, UpdateData>

A base crud repository that automatically handles creation of change sets and offers the option to "soft" delete entities (Meaning they are flagged as deleted but still kept for restoration).

Type Parameters

T extends SoftDeleteEntity
CreateData extends DeepPartial<T> = DeepPartial<T>
UpdateData extends DeepPartial<T> = DeepPartial<T>

Hierarchy (View Summary)

ChangeSetRepository<T, CreateData, UpdateData>
- SoftDeleteRepository

Constructors

constructor

new SoftDeleteRepository<
    T extends SoftDeleteEntity,
    CreateData extends

            | SoftDeleteEntity
            | {
                changeSets?: DeepPartial<ChangeSet[]>;
                deleted?: DeepPartial<boolean>;
                id?: string;
            } = DeepPartial<T>,
    UpdateData extends
        | SoftDeleteEntity
        | {
            changeSets?: DeepPartial<ChangeSet[]>;
            deleted?: DeepPartial<boolean>;
            id?: string;
        } = DeepPartial<T>,
>(
    entityClass: Newable<T>,
    repo: Repository<T> | Repository<T, DeepPartial<T>, DeepPartial<T>>,
    logger: LoggerInterface,
    dataSource: DataSourceInterface,
    beforeSave: BeforeSaveHook<T, CreateData, UpdateData>,
    beforeReturn: BeforeReturnHook<T>,
    authService: AuthServiceInterface,
    changeSetRepository: Repository<ChangeSet, CreateChangeSetData>,
): SoftDeleteRepository<T, CreateData, UpdateData>
Type Parameters
- T extends SoftDeleteEntity
- CreateData extends
      | SoftDeleteEntity
      | {
          changeSets?: DeepPartial<ChangeSet[]>;
          deleted?: DeepPartial<boolean>;
          id?: string;
      } = DeepPartial<T>
- UpdateData extends
      | SoftDeleteEntity
      | {
          changeSets?: DeepPartial<ChangeSet[]>;
          deleted?: DeepPartial<boolean>;
          id?: string;
      } = DeepPartial<T>
Parameters
- entityClass: Newable<T>
- repo: Repository<T> | Repository<T, DeepPartial<T>, DeepPartial<T>>
- logger: LoggerInterface
- dataSource: DataSourceInterface
- beforeSave: BeforeSaveHook<T, CreateData, UpdateData>
- beforeReturn: BeforeReturnHook<T>
- authService: AuthServiceInterface
- changeSetRepository: Repository<ChangeSet, CreateChangeSetData>
Returns SoftDeleteRepository<T, CreateData, UpdateData>
Overrides ChangeSetRepository.constructor
- Defined in src/change-sets/soft-delete-repository.ts:59

Accessors

dataSource

get dataSource(): DataSourceInterface
The data source that this repository is connected to.

Returns DataSourceInterface
Inherited from Repository.dataSource
- Defined in src/data-source/repository.ts:53

Methods

create

create(data: CreateData, options?: CreateOptions): Promise<T>
Creates a new entity from the given data.
Parameters
- data: CreateData
  The create data.
- Optionaloptions: CreateOptions
  Additional options, like a transaction etc.
Returns Promise<T>
The newly created entity.
Inherited from ChangeSetRepository.create
- Defined in src/change-sets/change-set-repository.ts:87

createAll

createAll(data: CreateData[], options?: CreateAllOptions): Promise<T[]>
Creates all entities from the provided data array.
Parameters
- data: CreateData[]
  An array of create data, which each creates a new entity.
- Optionaloptions: CreateAllOptions
  Additional options, eg. A transaction.
Returns Promise<T[]>
All newly created entities.
Inherited from ChangeSetRepository.createAll
- Defined in src/change-sets/change-set-repository.ts:93

deleteAll

deleteAll(
where: SoftDeleteWhere<T>,
options?: SoftDeleteAllOptions,
): Promise<T[]>
Deletes all entities that match the provided where filter.
Parameters
- where: SoftDeleteWhere<T>
  The where filter to find the entities that should be deleted.
- Optionaloptions: SoftDeleteAllOptions
  Additional options, like a transaction.
Returns Promise<T[]>
An array of all the deleted entities.
Overrides ChangeSetRepository.deleteAll
- Defined in src/change-sets/soft-delete-repository.ts:171

deleteById

deleteById(id: T["id"], options?: SoftDeleteByIdOptions): Promise<T>
Deletes an entity with the provided id.
Parameters
- id: T["id"]
  The id of the entity to deleted.
- Optionaloptions: SoftDeleteByIdOptions
  Additional options, like a transaction.
Returns Promise<T>
The deleted entity.
Overrides ChangeSetRepository.deleteById
- Defined in src/change-sets/soft-delete-repository.ts:157

findAll

findAll(options?: SoftDeleteFindAllOptions<T>): Promise<T[]>
Finds all entities with the given options.
Parameters
- Optionaloptions: SoftDeleteFindAllOptions<T>
  The options, including the where filter etc.
Returns Promise<T[]>
An array of found entities.
Overrides ChangeSetRepository.findAll
- Defined in src/change-sets/soft-delete-repository.ts:74

findAllPaginated

findAllPaginated(
    page: number,
    limit: number,
    options?: SoftDeleteFindAllPaginatedOptions<T>,
): Promise<PaginationResult<T>>
Finds all entities with the given options, in paginated form.
Parameters
- page: number
  The page for which the entities should be found.
- limit: number
  The limit of entities to receive for that page.
- Optionaloptions: SoftDeleteFindAllPaginatedOptions<T>
  Additional options including where filter etc.
Returns Promise<PaginationResult<T>>
A paginated result of the found entities.
Overrides ChangeSetRepository.findAllPaginated
- Defined in src/change-sets/soft-delete-repository.ts:108

findById

findById(id: T["id"], options?: SoftDeleteFindByIdOptions<T>): Promise<T>
Finds an entity by the given id.
Parameters
- id: T["id"]
  The id of the entity to find.
- Optionaloptions: SoftDeleteFindByIdOptions<T>
  Additional options, eg. Transaction.
Returns Promise<T>
The found entity.
Overrides ChangeSetRepository.findById
- Defined in src/change-sets/soft-delete-repository.ts:96

findOne

findOne<B extends boolean = true>(
options: SoftDeleteFindOneOptions<T>,
required?: B,
): Promise<B extends false ? T | undefined : T>
Finds a single entity with the given options.
Type Parameters
- B extends boolean = true
Parameters
- options: SoftDeleteFindOneOptions<T>
  The options, including the where filter etc.
- Optionalrequired: B
  Whether or not a result is required. Defaults to true.
Returns Promise<B extends false ? T | undefined : T>
The found result. If required is set to false, also undefined.
Overrides ChangeSetRepository.findOne
- Defined in src/change-sets/soft-delete-repository.ts:82

resetSingleChangeSet

resetSingleChangeSet(
    entity: T,
    changeSetId: string,
    createChangeSet?: boolean,
    preserveCreateChangeSet?: boolean,
    options?: BaseRepositoryOptions,
): Promise<ResetChangeSetResult<T>>
Resets the changes of a single change set on the given entity to the state before the change set. This DOES preserve any changes that happened after the change set. The given change set gets deleted afterwards.
Parameters
- entity: T
  The entity that should be reset.
- changeSetId: string
  The id of the changeSet to reset.
- createChangeSet: boolean = true
  Whether or not a change set should be created.
- preserveCreateChangeSet: boolean = true
  Whether or not create change sets should be preserved. In that case the entity gets reset to the state after the create change set. Also, the change set isn't deleted.
- Optionaloptions: BaseRepositoryOptions
  Additional options, eg. Transaction.
Returns Promise<ResetChangeSetResult<T>>
The updated entity.
Inherited from ChangeSetRepository.resetSingleChangeSet
- Defined in src/change-sets/change-set-repository.ts:148

resetSingleChangeSetById

resetSingleChangeSetById(
    id: T["id"],
    changeSetId: string,
    createChangeSet?: boolean,
    preserveCreateChangeSet?: boolean,
    options?: BaseRepositoryOptions,
): Promise<ResetChangeSetResult<T>>
Resets the changes of a single change set on the entity with the given id to the state before the oldest change set. This DOES preserve any changes that happened after the change set. The given change set gets deleted afterwards.
Parameters
- id: T["id"]
  The id of the entity that should be reset.
- changeSetId: string
  The id of the changeSet to reset.
- createChangeSet: boolean = true
  Whether or not a change set should be created.
- preserveCreateChangeSet: boolean = true
  Whether or not create change sets should be preserved. In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
- Optionaloptions: BaseRepositoryOptions
  Additional options, eg. Transaction.
Returns Promise<ResetChangeSetResult<T>>
The updated entity.
Inherited from ChangeSetRepository.resetSingleChangeSetById
- Defined in src/change-sets/change-set-repository.ts:190

rollbackAllToTimestamp

rollbackAllToTimestamp(
    timestampInNs: bigint,
    where?: Where<T>,
    createChangeSet?: boolean,
    preserveCreateChangeSet?: boolean,
    options?: BaseRepositoryOptions,
): Promise<number>
Rolls back all changes on the entities found with the given where filter to the state of the given timestamp. This DOES NOT preserve any changes that happened after the timestamp. Any change sets after the given timestamp will be deleted in the end.
Parameters
- timestampInNs: bigint
  The timestamp to which the rollback should happen with nanosecond precision.
- Optionalwhere: Where<T>
  A filter to only rollback some entities.
- createChangeSet: boolean = true
  Whether or not a change set should be created.
- preserveCreateChangeSet: boolean = true
  Whether or not create change sets should be preserved. In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
- Optionaloptions: BaseRepositoryOptions
  Additional options, eg. Transaction.
Returns Promise<number>
The updated entity.
Inherited from ChangeSetRepository.rollbackAllToTimestamp
- Defined in src/change-sets/change-set-repository.ts:329

rollbackToChangeSet

rollbackToChangeSet(
    entity: T,
    changeSetId: string,
    createChangeSet?: boolean,
    preserveCreateChangeSet?: boolean,
    options?: BaseRepositoryOptions,
): Promise<T>
Rolls back all changes on the given entity that have happened since the given change set. This DOES NOT preserve any changes that happened after the change set. The given change set and any change sets after that will be deleted in the end. Calls rollbackToTimestamp on the change set timestamp internally.
Parameters
- entity: T
  The entity to rollback.
- changeSetId: string
  The id of the changeSet to rollback to.
- createChangeSet: boolean = true
  Whether or not a change set should be created.
- preserveCreateChangeSet: boolean = true
  Whether or not create change sets should be preserved. In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
- Optionaloptions: BaseRepositoryOptions
  Additional options, eg. Transaction.
Returns Promise<T>
The updated entity.
Inherited from ChangeSetRepository.rollbackToChangeSet
- Defined in src/change-sets/change-set-repository.ts:214

rollbackToChangeSetById

rollbackToChangeSetById(
    id: T["id"],
    changeSetId: string,
    createChangeSet?: boolean,
    preserveCreateChangeSet?: boolean,
    options?: BaseRepositoryOptions,
): Promise<T>
Rolls back all changes on the entity with the given id that have happened since the given change set. This DOES NOT preserve any changes that happened after the change set. The given change set and any change sets after that will be deleted in the end. Calls rollbackToTimestampById on the change set timestamp internally.
Parameters
- id: T["id"]
  The id of the entity to rollback.
- changeSetId: string
  The id of the changeSet to rollback to.
- createChangeSet: boolean = true
  Whether or not a change set should be created.
- preserveCreateChangeSet: boolean = true
  Whether or not create change sets should be preserved. In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
- Optionaloptions: BaseRepositoryOptions
  Additional options, eg. Transaction.
Returns Promise<T>
The updated entity.
Inherited from ChangeSetRepository.rollbackToChangeSetById
- Defined in src/change-sets/change-set-repository.ts:238

rollbackToTimestamp

rollbackToTimestamp(
    entity: T,
    timestampInNs: bigint,
    createChangeSet?: boolean,
    preserveCreateChangeSet?: boolean,
    options?: BaseRepositoryOptions,
): Promise<T>
Rolls back all changes on the given entity that have happened since the given timestamp. This DOES NOT preserve any changes that happened after the timestamp. Any change sets after the given timestamp will be deleted in the end.
Parameters
- entity: T
  The entity to rollback.
- timestampInNs: bigint
  The timestamp to which the rollback should happen with nanosecond precision.
- createChangeSet: boolean = true
  Whether or not a change set should be created.
- preserveCreateChangeSet: boolean = true
  Whether or not create change sets should be preserved. In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
- Optionaloptions: BaseRepositoryOptions
  Additional options, eg. Transaction.
Returns Promise<T>
The updated entity.
Inherited from ChangeSetRepository.rollbackToTimestamp
- Defined in src/change-sets/change-set-repository.ts:266

rollbackToTimestampById

rollbackToTimestampById(
    id: T["id"],
    timestampInNs: bigint,
    createChangeSet?: boolean,
    preserveCreateChangeSet?: boolean,
    options?: BaseRepositoryOptions,
): Promise<T>
Rolls back all changes on the entity with the given id that have happened since the given timestamp. This DOES NOT preserve any changes that happened after the timestamp. Any change sets after the given timestamp will be deleted in the end.
Parameters
- id: T["id"]
  The id of the entity to rollback.
- timestampInNs: bigint
  The timestamp to which the rollback should happen with nanosecond precision.
- createChangeSet: boolean = true
  Whether or not a change set should be created.
- preserveCreateChangeSet: boolean = true
  Whether or not create change sets should be preserved. In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
- Optionaloptions: BaseRepositoryOptions
  Additional options, eg. Transaction.
Returns Promise<T>
The updated entity.
Inherited from ChangeSetRepository.rollbackToTimestampById
- Defined in src/change-sets/change-set-repository.ts:306

updateAll

updateAll(
    where: SoftDeleteWhere<T>,
    data: UpdateData,
    options?: SoftDeleteUpdateAllOptions,
): Promise<T[]>
Updates all entities that match the provided where filter.
Parameters
- where: SoftDeleteWhere<T>
  The where filter to find the entities that should be updated.
- data: UpdateData
  The data to update the entities with.
- Optionaloptions: SoftDeleteUpdateAllOptions
  Additional options, like a transaction.
Returns Promise<T[]>
An array of all the updated entities.
Overrides ChangeSetRepository.updateAll
- Defined in src/change-sets/soft-delete-repository.ts:120

updateAllWithoutChangeSet

updateAllWithoutChangeSet(
    where: Where<T>,
    data: UpdateData,
    options?: BaseRepositoryOptions,
): Promise<T[]>
Updates all entities that match the provided where filter.
Parameters
- where: Where<T>
  The where filter to find the entities that should be updated.
- data: UpdateData
  The data to update the entities with.
- Optionaloptions: BaseRepositoryOptions
  Additional options, like a transaction.
Returns Promise<T[]>
An array of all the updated entities.
Inherited from ChangeSetRepository.updateAllWithoutChangeSet
- Defined in src/change-sets/change-set-repository.ts:132

updateById

updateById(
    id: T["id"],
    data: UpdateData,
    options?: SoftDeleteUpdateByIdOptions,
): Promise<T>
Updates an entity with the provided id.
Parameters
- id: T["id"]
  The id of the entity to update.
- data: UpdateData
  The data to update the entity with.
- Optionaloptions: SoftDeleteUpdateByIdOptions
  Additional options, like a transaction.
Returns Promise<T>
The updated entity.
Overrides ChangeSetRepository.updateById
- Defined in src/change-sets/soft-delete-repository.ts:133

updateByIdWithoutChangeSet

updateByIdWithoutChangeSet(
    id: T["id"],
    data: UpdateData,
    options?: SoftDeleteUpdateByIdOptions,
): Promise<T>
Update an entity by id with property/value pairs in the data object.
Parameters
- id: T["id"]
  Value for the entity id.
- data: UpdateData
  Data attributes to be updated.
- Optionaloptions: SoftDeleteUpdateByIdOptions
  Options for the operations.
Returns Promise<T>
A promise that will be resolve if the operation succeeded or will be rejected if the entity was not found.
Overrides ChangeSetRepository.updateByIdWithoutChangeSet
- Defined in src/change-sets/soft-delete-repository.ts:151

Class SoftDeleteRepository<T, CreateData, UpdateData>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SoftDeleteRepository<T, CreateData, UpdateData>

Accessors

dataSource

Returns DataSourceInterface

Methods

create

Parameters

Returns Promise<T>

createAll

Parameters

Returns Promise<T[]>

deleteAll

Parameters

Returns Promise<T[]>

deleteById

Parameters

Returns Promise<T>

findAll

Parameters

Returns Promise<T[]>

findAllPaginated

Parameters

Returns Promise<PaginationResult<T>>

findById

Parameters

Returns Promise<T>

findOne

Type Parameters

Parameters

Returns Promise<B extends false ? T | undefined : T>

resetSingleChangeSet

Parameters

Returns Promise<ResetChangeSetResult<T>>

resetSingleChangeSetById

Parameters

Returns Promise<ResetChangeSetResult<T>>

rollbackAllToTimestamp

Parameters

Returns Promise<number>

rollbackToChangeSet

Parameters

Returns Promise<T>

rollbackToChangeSetById

Parameters

Returns Promise<T>

rollbackToTimestamp

Parameters

Returns Promise<T>

rollbackToTimestampById

Parameters

Returns Promise<T>

updateAll

Parameters

Returns Promise<T[]>

updateAllWithoutChangeSet

Parameters

Returns Promise<T[]>

updateById

Parameters

Returns Promise<T>

updateByIdWithoutChangeSet

Parameters

Returns Promise<T>

Settings

On This Page