Abstract Class: ReadRepository<TClient, TEntity, TId = `string`, TTx = `TClient`>
Defined in: server/persistence/base-repository.ts:161
Repository with read-only capabilities.
Extends
BaseRepository<TClient,TTx>
Extended by
LifecycleTransitionRepositoryLifecycleEffectRepositoryVersionRepositoryWriteRepositoryConditionRepositoryRuleRepository
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
TClient | - | The consumer's generated PrismaClient type |
TEntity | - | The entity type |
TId | string | The ID type (defaults to string) |
TTx | TClient | The transaction handle type (defaults to TClient) |
Constructors
Constructor
new ReadRepository<TClient, TEntity, TId = string, TTx = TClient>(prismaClient: PrismaClientLike<TTx> & TClient, options?: RepositoryOptions): ReadRepository<TClient, TEntity, TId, TTx>;Defined in: server/persistence/base-repository.ts:68
Parameters
| Parameter | Type |
|---|---|
prismaClient | PrismaClientLike<TTx> & TClient |
options | RepositoryOptions |
Returns
ReadRepository<TClient, TEntity, TId, 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>
_exists()
abstract protected _exists(id: TId): Promise<boolean>;Defined in: server/persistence/base-repository.ts:168
Parameters
| Parameter | Type |
|---|---|
id | TId |
Returns
Promise<boolean>
_findById()
abstract protected _findById(id: TId): Promise<TEntity | null>;Defined in: server/persistence/base-repository.ts:167
Parameters
| Parameter | Type |
|---|---|
id | TId |
Returns
Promise<TEntity | null>
_findMany()
abstract protected _findMany(pagination: {
page: number;
pageSize: number;
}): Promise<{
items: TEntity[];
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: TEntity[];
total: number;
}>
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>
exists()
exists(id: TId): Promise<boolean>;Defined in: server/persistence/base-repository.ts:187
Parameters
| Parameter | Type |
|---|---|
id | TId |
Returns
Promise<boolean>
findById()
findById(id: TId): Promise<TEntity | null>;Defined in: server/persistence/base-repository.ts:177
Parameters
| Parameter | Type |
|---|---|
id | TId |
Returns
Promise<TEntity | null>
findByIdOrThrow()
findByIdOrThrow(id: TId): Promise<TEntity>;Defined in: server/persistence/base-repository.ts:181
Parameters
| Parameter | Type |
|---|---|
id | TId |
Returns
Promise<TEntity>
findMany()
findMany(pagination: {
page: number;
pageSize: number;
}): Promise<OffsetPaginatedResult<TEntity>>;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<TEntity>>
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: TId): Error;Defined in: server/persistence/base-repository.ts:175
Create a not-found error. Override to provide custom error types.
Parameters
| Parameter | Type |
|---|---|
id | TId |
Returns
Error