Kaizen
Browse modulesPersistenceClasses

Abstract Class: ReadRepository<TClient, TEntity, TId = `string`, TTx = `TClient`>

Defined in: server/persistence/base-repository.ts:161

Repository with read-only capabilities.

Extends

Extended by

Type Parameters

Type ParameterDefault typeDescription
TClient-The consumer's generated PrismaClient type
TEntity-The entity type
TIdstringThe ID type (defaults to string)
TTxTClientThe 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

ParameterType
prismaClientPrismaClientLike<TTx> & TClient
optionsRepositoryOptions

Returns

ReadRepository<TClient, TEntity, TId, TTx>

Inherited from

BaseRepository.constructor

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

BaseRepository.ENTITY_TYPE


logger?

protected readonly optional logger?: Logger;

Defined in: server/persistence/base-repository.ts:64

Inherited from

BaseRepository.logger


prismaClient

protected prismaClient: PrismaClientLike<TTx> & TClient;

Defined in: server/persistence/base-repository.ts:69

Inherited from

BaseRepository.prismaClient

Accessors

actorId

Get Signature

get protected actorId(): string | null | undefined;

Defined in: server/persistence/base-repository.ts:76

Returns

string | null | undefined

Inherited from

BaseRepository.actorId


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

BaseRepository.auditCreate


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

BaseRepository.auditDelete


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

BaseRepository.auditUpdate


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 normally
Returns

this

Inherited from

BaseRepository.silent


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

BaseRepository.tx

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

ParameterType
idTId

Returns

Promise<boolean>


_findById()

abstract protected _findById(id: TId): Promise<TEntity | null>;

Defined in: server/persistence/base-repository.ts:167

Parameters

ParameterType
idTId

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

ParameterType
pagination{ page: number; pageSize: number; }
pagination.pagenumber
pagination.pageSizenumber

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

BaseRepository.consumeSilent


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

ParameterType
idTId

Returns

Promise<boolean>


findById()

findById(id: TId): Promise<TEntity | null>;

Defined in: server/persistence/base-repository.ts:177

Parameters

ParameterType
idTId

Returns

Promise<TEntity | null>


findByIdOrThrow()

findByIdOrThrow(id: TId): Promise<TEntity>;

Defined in: server/persistence/base-repository.ts:181

Parameters

ParameterType
idTId

Returns

Promise<TEntity>


findMany()

findMany(pagination: {
  page: number;
  pageSize: number;
}): Promise<OffsetPaginatedResult<TEntity>>;

Defined in: server/persistence/base-repository.ts:195

Parameters

ParameterType
pagination{ page: number; pageSize: number; }
pagination.pagenumber
pagination.pageSizenumber

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

ParameterType
_entityIdstring
_actionstring
_metadata?Record<string, unknown>

Returns

Promise<void>

Inherited from

BaseRepository.logActivity


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

ParameterType
idTId

Returns

Error

On this page