Abstract Class: VersionRepository<TClient, TVersion *extends* `Versioned`, TCreateInput, TParentId = `string`, TTx = `TClient`>
Defined in: server/persistence/base-repository.ts:222
Repository for version entities in parent-child versioning patterns.
Use for entities that:
- link to a parent entity via
parentId - order versions by
versionNumber - are append-only (immutable once created)
Provides findByParentId, findLatestByParentId,
getNextVersionNumber, countByParentId, and an audit-aware create.
Extends
ReadRepository<TClient,TVersion,string,TTx>
Extended by
ConditionVersionRepositoryRuleVersionRepositoryRoleVersionRepositoryFormSchemaVersionRepositoryFormSubmissionVersionRepository
Type Parameters
| Type Parameter | Default type |
|---|---|
TClient | - |
TVersion extends Versioned | - |
TCreateInput | - |
TParentId | string |
TTx | TClient |
Constructors
Constructor
new VersionRepository<TClient, TVersion extends Versioned, TCreateInput, TParentId = string, TTx = TClient>(prismaClient: PrismaClientLike<TTx> & TClient, options?: RepositoryOptions): VersionRepository<TClient, TVersion, TCreateInput, TParentId, TTx>;Defined in: server/persistence/base-repository.ts:68
Parameters
| Parameter | Type |
|---|---|
prismaClient | PrismaClientLike<TTx> & TClient |
options | RepositoryOptions |
Returns
VersionRepository<TClient, TVersion, TCreateInput, TParentId, TTx>
Inherited from
Properties
ENTITY_TYPE?
protected readonly optional ENTITY_TYPE?: string;Defined in: server/persistence/base-repository.ts:61
Set ENTITY_TYPE in child repositories to enable automatic activity
logging. When set, create/update/delete operations auto-log unless
silenced with .silent. Requires an activity model on the consumer's
Prisma schema.
Inherited from
logger?
protected readonly optional logger?: Logger;Defined in: server/persistence/base-repository.ts:64
Inherited from
prismaClient
protected prismaClient: PrismaClientLike<TTx> & TClient;Defined in: server/persistence/base-repository.ts:69
Inherited from
Accessors
actorId
Get Signature
get protected actorId(): string | null | undefined;Defined in: server/persistence/base-repository.ts:76
Returns
string | null | undefined
Inherited from
auditCreate
Get Signature
get protected auditCreate(): {
createdBy: string | null | undefined;
updatedBy: string | null | undefined;
};Defined in: server/persistence/base-repository.ts:90
Returns
{
createdBy: string | null | undefined;
updatedBy: string | null | undefined;
}createdBy
createdBy: string | null | undefined = actorId;updatedBy
updatedBy: string | null | undefined = actorId;Inherited from
auditDelete
Get Signature
get protected auditDelete(): {
deletedAt: Date;
deletedBy: string | null | undefined;
};Defined in: server/persistence/base-repository.ts:99
Returns
{
deletedAt: Date;
deletedBy: string | null | undefined;
}deletedAt
deletedAt: Date;deletedBy
deletedBy: string | null | undefined;Inherited from
auditUpdate
Get Signature
get protected auditUpdate(): {
updatedBy: string | null | undefined;
};Defined in: server/persistence/base-repository.ts:95
Returns
{
updatedBy: string | null | undefined;
}updatedBy
updatedBy: string | null | undefined;Inherited from
silent
Get Signature
get silent(): this;Defined in: server/persistence/base-repository.ts:115
Suppress activity logging for the next mutation call. One-shot: the flag is consumed by the next create/update/delete.
Example
await repo.silent.update(id, data); // no activity logged
await repo.update(id, data); // activity logged normallyReturns
this
Inherited from
tx
Get Signature
get protected tx(): TTx;Defined in: server/persistence/base-repository.ts:86
The current Prisma handle: the active transaction if one is running on this async context, otherwise the raw client.
Returns
TTx
Inherited from
Methods
_count()
abstract protected _count(): Promise<number>;Defined in: server/persistence/base-repository.ts:169
Returns
Promise<number>
Inherited from
_countByParentId()
abstract protected _countByParentId(parentId: TParentId): Promise<number>;Defined in: server/persistence/base-repository.ts:230
Parameters
| Parameter | Type |
|---|---|
parentId | TParentId |
Returns
Promise<number>
_create()
abstract protected _create(input: TCreateInput): Promise<TVersion>;Defined in: server/persistence/base-repository.ts:231
Parameters
| Parameter | Type |
|---|---|
input | TCreateInput |
Returns
Promise<TVersion>
_exists()
abstract protected _exists(id: string): Promise<boolean>;Defined in: server/persistence/base-repository.ts:168
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<boolean>
Inherited from
_findById()
abstract protected _findById(id: string): Promise<TVersion | null>;Defined in: server/persistence/base-repository.ts:167
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<TVersion | null>
Inherited from
_findByParentId()
abstract protected _findByParentId(parentId: TParentId): Promise<TVersion[]>;Defined in: server/persistence/base-repository.ts:229
Parameters
| Parameter | Type |
|---|---|
parentId | TParentId |
Returns
Promise<TVersion[]>
_findMany()
abstract protected _findMany(pagination: {
page: number;
pageSize: number;
}): Promise<{
items: TVersion[];
total: number;
}>;Defined in: server/persistence/base-repository.ts:170
Parameters
| Parameter | Type |
|---|---|
pagination | { page: number; pageSize: number; } |
pagination.page | number |
pagination.pageSize | number |
Returns
Promise<{
items: TVersion[];
total: number;
}>
Inherited from
consumeSilent()
protected consumeSilent(): boolean;Defined in: server/persistence/base-repository.ts:128
Consume and reset the silent flag. Called by template methods.
Returns
boolean
Inherited from
count()
count(): Promise<number>;Defined in: server/persistence/base-repository.ts:191
Returns
Promise<number>
Inherited from
countByParentId()
countByParentId(parentId: TParentId): Promise<number>;Defined in: server/persistence/base-repository.ts:261
Parameters
| Parameter | Type |
|---|---|
parentId | TParentId |
Returns
Promise<number>
create()
create(input: TCreateInput): Promise<TVersion>;Defined in: server/persistence/base-repository.ts:265
Parameters
| Parameter | Type |
|---|---|
input | TCreateInput |
Returns
Promise<TVersion>
exists()
exists(id: string): Promise<boolean>;Defined in: server/persistence/base-repository.ts:187
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<boolean>
Inherited from
findById()
findById(id: string): Promise<TVersion | null>;Defined in: server/persistence/base-repository.ts:177
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<TVersion | null>
Inherited from
findByIdOrThrow()
findByIdOrThrow(id: string): Promise<TVersion>;Defined in: server/persistence/base-repository.ts:181
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<TVersion>
Inherited from
ReadRepository.findByIdOrThrow
findByParentId()
findByParentId(parentId: TParentId): Promise<TVersion[]>;Defined in: server/persistence/base-repository.ts:233
Parameters
| Parameter | Type |
|---|---|
parentId | TParentId |
Returns
Promise<TVersion[]>
findLatestByParentId()
findLatestByParentId(parentId: TParentId): Promise<TVersion | null>;Defined in: server/persistence/base-repository.ts:237
Parameters
| Parameter | Type |
|---|---|
parentId | TParentId |
Returns
Promise<TVersion | null>
findMany()
findMany(pagination: {
page: number;
pageSize: number;
}): Promise<OffsetPaginatedResult<TVersion>>;Defined in: server/persistence/base-repository.ts:195
Parameters
| Parameter | Type |
|---|---|
pagination | { page: number; pageSize: number; } |
pagination.page | number |
pagination.pageSize | number |
Returns
Promise<OffsetPaginatedResult<TVersion>>
Inherited from
getNextVersionNumber()
getNextVersionNumber(parentId: TParentId): Promise<number>;Defined in: server/persistence/base-repository.ts:256
Next version number = highest versionNumber among the rows
_findByParentId returns, plus one. Subclasses typically filter
_findByParentId to deletedAt: null, so this counts only live rows.
That is collision-safe only while the subclass never soft-deletes
version rows. If a subclass gains a discard/soft-delete path AND its
@@unique(parentId, versionNumber) constraint counts soft-deleted rows
(Postgres unique indexes do), reusing a discarded row's number will
violate the constraint. Such a subclass must override to compute the
max over all rows including soft-deleted — see
FormSchemaVersionRepository.nextVersionNumber. Promote that into a
shared abstract hook here once a second repo needs it.
Parameters
| Parameter | Type |
|---|---|
parentId | TParentId |
Returns
Promise<number>
logActivity()
protected logActivity(
_entityId: string,
_action: string,
_metadata?: Record<string, unknown>
): Promise<void>;Defined in: server/persistence/base-repository.ts:140
Log an activity entry.
NOTE: This is not implemented because there's no activity model implemented in taproot yet! https://linear.app/kaizenlabs/issue/ENG-7846/add-activity-log-tables
Parameters
| Parameter | Type |
|---|---|
_entityId | string |
_action | string |
_metadata? | Record<string, unknown> |
Returns
Promise<void>
Inherited from
notFoundError()
abstract protected notFoundError(id: string): Error;Defined in: server/persistence/base-repository.ts:175
Create a not-found error. Override to provide custom error types.
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Error