Class ChangeSetRepository<T, CreateData, UpdateData>

A base repository that automatically handles creation of change sets.

Type Parameters

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

Hierarchy (View Summary)

Repository<T, CreateData, UpdateData>
- ChangeSetRepository
  - SoftDeleteRepository

Constructors

constructor

new ChangeSetRepository<
    T extends ChangeSetEntity,
    CreateData extends

            | ChangeSetEntity
            | { changeSets?: DeepPartial<ChangeSet[]>; id?: string } = DeepPartial<T>,
    UpdateData extends
        | ChangeSetEntity
        | { changeSets?: DeepPartial<ChangeSet[]>; id?: string } = DeepPartial<T>,
>(
    entityClass: Newable<T>,
    repo: Repository<T> | Repository<T, DeepPartial<T>, DeepPartial<T>>,
): ChangeSetRepository<T, CreateData, UpdateData>
Type Parameters
- T extends ChangeSetEntity
- CreateData extends ChangeSetEntity | { changeSets?: DeepPartial<ChangeSet[]>; id?: string } = DeepPartial<T>
- UpdateData extends ChangeSetEntity | { changeSets?: DeepPartial<ChangeSet[]>; id?: string } = DeepPartial<T>
Parameters
- entityClass: Newable<T>
- repo: Repository<T> | Repository<T, DeepPartial<T>, DeepPartial<T>>
Returns ChangeSetRepository<T, CreateData, UpdateData>
Overrides Repository.constructor
- Defined in src/change-sets/change-set-repository.model.ts:53

Methods

create

create(data: CreateData, options?: CreateOptions): Promise<T>
Creates a new entity from the given data. Internally this uses insert.
Parameters
- data: CreateData
  The create data.
- Optionaloptions: CreateOptions
  Additional options, like a transaction etc.
Returns Promise<T>
The newly created entity.
Overrides Repository.create
- Defined in src/change-sets/change-set-repository.model.ts:65

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.
Overrides Repository.createAll
- Defined in src/change-sets/change-set-repository.model.ts:71

deleteAll

deleteAll(where: Where<T>, options?: DeleteAllOptions<T>): Promise<T[]>
Deletes all entities that match the provided where filter.
Parameters
- where: Where<T>
  The where filter to find the entities that should be deleted.
- Optionaloptions: DeleteAllOptions<T>
  Additional options, like a transaction.
Returns Promise<T[]>
An array of all the updated entities.
Inherited from Repository.deleteAll
- Defined in src/data-source/repository.model.ts:233

deleteById

deleteById(id: T["id"], options?: BaseRepositoryOptions): Promise<void>
Deletes an entity with the provided id.
Parameters
- id: T["id"]
  The id of the entity to deleted.
- Optionaloptions: BaseRepositoryOptions
  Additional options, like a transaction.
Returns Promise<void>
Inherited from Repository.deleteById
- Defined in src/data-source/repository.model.ts:221

findAll

findAll(options?: FindAllOptions<T>): Promise<T[]>
Finds all entities with the given options.
Parameters
- Optionaloptions: FindAllOptions<T>
  The options, including the where filter etc.
Returns Promise<T[]>
An array of found entities.
Inherited from Repository.findAll
- Defined in src/data-source/repository.model.ts:146

findAllPaginated

findAllPaginated(
    page: number,
    limit: number,
    options?: FindAllPaginatedOptions<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: FindAllPaginatedOptions<T>
  Additional options including where filter etc.
Returns Promise<PaginationResult<T>>
A paginated result of the found entities.
Inherited from Repository.findAllPaginated
- Defined in src/data-source/repository.model.ts:162

findById

findById(id: T["id"], options?: FindByIdOptions<T>): Promise<T>
Finds an entity by the given id.
Parameters
- id: T["id"]
  The id of the entity to find.
- Optionaloptions: FindByIdOptions<T>
  Additional options, eg. Transaction.
Returns Promise<T>
The found entity.
Inherited from Repository.findById
- Defined in src/data-source/repository.model.ts:111

findOne

findOne<B extends boolean = true>(
options: FindOneOptions<T>,
required?: B,
): Promise<B extends false ? undefined | T : T>
Finds a single entity with the given options.
Type Parameters
- B extends boolean = true
Parameters
- options: FindOneOptions<T>
  The options, including the where filter etc.
- required: B = ...
  Whether or not a result is required. Defaults to true.
Returns Promise<B extends false ? undefined | T : T>
The found result. If required is set to false, also undefined.
Inherited from Repository.findOne
- Defined in src/data-source/repository.model.ts:125

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.
- Defined in src/change-sets/change-set-repository.model.ts:124

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.
- Defined in src/change-sets/change-set-repository.model.ts:166

rollbackAllToDate

rollbackAllToDate(
    date: Date,
    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 date. This DOES NOT preserve any changes that happened after the date. Any change sets after the given date will be deleted in the end.
Parameters
- date: Date
  The date to which the rollback should happen.
- 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.
- Defined in src/change-sets/change-set-repository.model.ts:306

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 rollbackByDate on the change set date 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.
- Defined in src/change-sets/change-set-repository.model.ts:190

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 rollbackByDate on the change set date 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.
- Defined in src/change-sets/change-set-repository.model.ts:214

rollbackToDate

rollbackToDate(
    entity: T,
    date: Date,
    createChangeSet?: boolean,
    preserveCreateChangeSet?: boolean,
    options?: BaseRepositoryOptions,
): Promise<T>
Rolls back all changes on the given entity that have happened since the given date. This DOES NOT preserve any changes that happened after the date. Any change sets after the given date will be deleted in the end.
Parameters
- entity: T
  The entity to rollback.
- date: Date
  The date to which the rollback should happen.
- 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.
- Defined in src/change-sets/change-set-repository.model.ts:242

rollbackToDateById

rollbackToDateById(
    id: T["id"],
    date: Date,
    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 date. This DOES NOT preserve any changes that happened after the date. Any change sets after the given date will be deleted in the end.
Parameters
- id: T["id"]
  The id of the entity to rollback.
- date: Date
  The date to which the rollback should happen.
- 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.
- Defined in src/change-sets/change-set-repository.model.ts:283

updateAll

updateAll(
    where: Where<T>,
    data: UpdateData,
    options?: UpdateAllOptions,
): 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: UpdateAllOptions
  Additional options, like a transaction.
Returns Promise<T[]>
An array of all the updated entities.
Overrides Repository.updateAll
- Defined in src/change-sets/change-set-repository.model.ts:83

updateAllWithoutChangeSet

updateAllWithoutChangeSet(
    where: Where<T>,
    data: UpdateData,
    options?: UpdateAllOptions,
): 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: UpdateAllOptions
  Additional options, like a transaction.
Returns Promise<T[]>
An array of all the updated entities.
- Defined in src/change-sets/change-set-repository.model.ts:108

updateById

updateById(
    id: T["id"],
    data: UpdateData,
    options?: UpdateByIdOptions,
): 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: UpdateByIdOptions
  Additional options, like a transaction.
Returns Promise<T>
The updated entity.
Overrides Repository.updateById
- Defined in src/change-sets/change-set-repository.model.ts:77

updateByIdWithoutChangeSet

updateByIdWithoutChangeSet(
    id: T["id"],
    data: UpdateData,
    options?: UpdateByIdOptions,
): 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: UpdateByIdOptions
  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.
- Defined in src/change-sets/change-set-repository.model.ts:97

Class ChangeSetRepository<T, CreateData, UpdateData>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ChangeSetRepository<T, CreateData, UpdateData>

Methods

create

Parameters

Returns Promise<T>

createAll

Parameters

Returns Promise<T[]>

deleteAll

Parameters

Returns Promise<T[]>

deleteById

Parameters

Returns Promise<void>

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 ? undefined | T : T>

resetSingleChangeSet

Parameters

Returns Promise<ResetChangeSetResult<T>>

resetSingleChangeSetById

Parameters

Returns Promise<ResetChangeSetResult<T>>

rollbackAllToDate

Parameters

Returns Promise<number>

rollbackToChangeSet

Parameters

Returns Promise<T>

rollbackToChangeSetById

Parameters

Returns Promise<T>

rollbackToDate

Parameters

Returns Promise<T>

rollbackToDateById

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