Class: FormSchemaVersionRepository

Defined in: server/forms/form-schema-version-repository.ts:48

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.

ExtendsCopy Anchor Link

• VersionRepository<PrismaClient, FormSchemaVersions, CreateInput, string, Tx<PrismaClient>>

ConstructorsCopy Anchor Link

ConstructorCopy Anchor Link

new FormSchemaVersionRepository(prismaClient: PrismaClientLike<Tx<PrismaClient<PrismaClientOptions, never, DefaultArgs>>> & PrismaClient<PrismaClientOptions, never, DefaultArgs>, options?: RepositoryOptions): FormSchemaVersionRepository;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

FormSchemaVersionRepository

Inherited fromCopy Anchor Link

VersionRepository.constructor

PropertiesCopy Anchor Link

ENTITY_TYPE?Copy Anchor Link

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 fromCopy Anchor Link

VersionRepository.ENTITY_TYPE

logger?Copy Anchor Link

protected readonly optional logger?: Logger;

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

Inherited fromCopy Anchor Link

VersionRepository.logger

prismaClientCopy Anchor Link

protected prismaClient: PrismaClientLike<Tx<PrismaClient<PrismaClientOptions, never, DefaultArgs>>> & PrismaClient<PrismaClientOptions, never, DefaultArgs>;

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

Inherited fromCopy Anchor Link

VersionRepository.prismaClient

AccessorsCopy Anchor Link

actorIdCopy Anchor Link

Get SignatureCopy Anchor Link

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

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

ReturnsCopy Anchor Link

string | null | undefined

Inherited fromCopy Anchor Link

VersionRepository.actorId

auditCreateCopy Anchor Link

Get SignatureCopy Anchor Link

get protected auditCreate(): {
  createdBy: string | null | undefined;
  updatedBy: string | null | undefined;
};

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

ReturnsCopy Anchor Link

{
  createdBy: string | null | undefined;
  updatedBy: string | null | undefined;
}

createdByCopy Anchor Link

createdBy: string | null | undefined = actorId;

updatedByCopy Anchor Link

updatedBy: string | null | undefined = actorId;

Inherited fromCopy Anchor Link

VersionRepository.auditCreate

auditDeleteCopy Anchor Link

Get SignatureCopy Anchor Link

get protected auditDelete(): {
  deletedAt: Date;
  deletedBy: string | null | undefined;
};

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

ReturnsCopy Anchor Link

{
  deletedAt: Date;
  deletedBy: string | null | undefined;
}

deletedAtCopy Anchor Link

deletedAt: Date;

deletedByCopy Anchor Link

deletedBy: string | null | undefined;

Inherited fromCopy Anchor Link

VersionRepository.auditDelete

auditUpdateCopy Anchor Link

Get SignatureCopy Anchor Link

get protected auditUpdate(): {
  updatedBy: string | null | undefined;
};

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

ReturnsCopy Anchor Link

{
  updatedBy: string | null | undefined;
}

updatedByCopy Anchor Link

updatedBy: string | null | undefined;

Inherited fromCopy Anchor Link

VersionRepository.auditUpdate

silentCopy Anchor Link

Get SignatureCopy Anchor Link

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.

ExampleCopy Anchor Link

await repo.silent.update(id, data);   // no activity logged
await repo.update(id, data);          // activity logged normally

ReturnsCopy Anchor Link

this

Inherited fromCopy Anchor Link

VersionRepository.silent

txCopy Anchor Link

Get SignatureCopy Anchor Link

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.

ReturnsCopy Anchor Link

TTx

Inherited fromCopy Anchor Link

VersionRepository.tx

MethodsCopy Anchor Link

_count()Copy Anchor Link

protected _count(): Promise<number>;

Defined in: server/forms/form-schema-version-repository.ts:72

ReturnsCopy Anchor Link

Promise<number>

OverridesCopy Anchor Link

VersionRepository._count

_countByParentId()Copy Anchor Link

protected _countByParentId(formSchemaId: string): Promise<number>;

Defined in: server/forms/form-schema-version-repository.ts:102

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<number>

OverridesCopy Anchor Link

VersionRepository._countByParentId

_create()Copy Anchor Link

protected _create(input: CreateInput): Promise<{
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}>;

Defined in: server/forms/form-schema-version-repository.ts:108

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<{ changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; }>

OverridesCopy Anchor Link

VersionRepository._create

_exists()Copy Anchor Link

protected _exists(id: string): Promise<boolean>;

Defined in: server/forms/form-schema-version-repository.ts:65

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

OverridesCopy Anchor Link

VersionRepository._exists

_findById()Copy Anchor Link

protected _findById(id: string): Promise<
  | {
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}
| null>;

Defined in: server/forms/form-schema-version-repository.ts:59

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise< | { changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; } | null>

OverridesCopy Anchor Link

VersionRepository._findById

_findByParentId()Copy Anchor Link

protected _findByParentId(formSchemaId: string): Promise<{
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}[]>;

Defined in: server/forms/form-schema-version-repository.ts:93

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<{ changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; }[]>

OverridesCopy Anchor Link

VersionRepository._findByParentId

_findMany()Copy Anchor Link

protected _findMany(pagination: {
  page: number;
  pageSize: number;
}): Promise<{
  items: {
     changeReason: string | null;
     createdAt: Date;
     createdBy: string | null;
     deletedAt: Date | null;
     deletedBy: string | null;
     entryStepKey: string | null;
     formSchemaId: string;
     id: string;
     publishedAt: Date | null;
     schema: JsonValue;
     versionNumber: number;
  }[];
  total: number;
}>;

Defined in: server/forms/form-schema-version-repository.ts:76

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<{ items: { changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; }[]; total: number; }>

OverridesCopy Anchor Link

VersionRepository._findMany

consumeSilent()Copy Anchor Link

protected consumeSilent(): boolean;

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

Consume and reset the silent flag. Called by template methods.

ReturnsCopy Anchor Link

boolean

Inherited fromCopy Anchor Link

VersionRepository.consumeSilent

count()Copy Anchor Link

count(): Promise<number>;

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

ReturnsCopy Anchor Link

Promise<number>

Inherited fromCopy Anchor Link

VersionRepository.count

countByParentId()Copy Anchor Link

countByParentId(parentId: string): Promise<number>;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<number>

Inherited fromCopy Anchor Link

VersionRepository.countByParentId

create()Copy Anchor Link

create(input: CreateInput): Promise<{
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}>;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<{ changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; }>

Inherited fromCopy Anchor Link

VersionRepository.create

exists()Copy Anchor Link

exists(id: string): Promise<boolean>;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

Inherited fromCopy Anchor Link

VersionRepository.exists

findByFormSchemaId()Copy Anchor Link

findByFormSchemaId(formSchemaId: string): Promise<{
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}[]>;

Defined in: server/forms/form-schema-version-repository.ts:180

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<{ changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; }[]>

findById()Copy Anchor Link

findById(id: string): Promise<
  | {
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}
| null>;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise< | { changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; } | null>

Inherited fromCopy Anchor Link

VersionRepository.findById

findByIdOrThrow()Copy Anchor Link

findByIdOrThrow(id: string): Promise<{
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}>;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<{ changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; }>

Inherited fromCopy Anchor Link

VersionRepository.findByIdOrThrow

findByParentId()Copy Anchor Link

findByParentId(parentId: string): Promise<{
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}[]>;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<{ changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; }[]>

Inherited fromCopy Anchor Link

VersionRepository.findByParentId

findLatestByFormSchemaId()Copy Anchor Link

findLatestByFormSchemaId(formSchemaId: string): Promise<
  | {
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}
| null>;

Defined in: server/forms/form-schema-version-repository.ts:186

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise< | { changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; } | null>

findLatestByParentId()Copy Anchor Link

findLatestByParentId(parentId: string): Promise<
  | {
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}
| null>;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise< | { changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; } | null>

Inherited fromCopy Anchor Link

VersionRepository.findLatestByParentId

findMany()Copy Anchor Link

findMany(pagination: {
  page: number;
  pageSize: number;
}): Promise<OffsetPaginatedResult<{
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}>>;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<OffsetPaginatedResult<{ changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; }>>

Inherited fromCopy Anchor Link

VersionRepository.findMany

getNextVersionNumber()Copy Anchor Link

getNextVersionNumber(parentId: string): 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.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<number>

Inherited fromCopy Anchor Link

VersionRepository.getNextVersionNumber

logActivity()Copy Anchor Link

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

Inherited fromCopy Anchor Link

VersionRepository.logActivity

nextVersionNumber()Copy Anchor Link

nextVersionNumber(formSchemaId: string): Promise<number>;

Defined in: server/forms/form-schema-version-repository.ts:201

Next version number for a schema, computed over all rows including soft-deleted ones. The @@unique([formSchemaId, versionNumber]) constraint counts soft-deleted rows, so reusing a discarded draft's number would collide. We therefore can't lean on the base getNextVersionNumber (which reads findLatestByParentId, filtered to deletedAt: null) — version numbers must stay monotonic across the schema's entire history, discarded drafts included.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<number>

notFoundError()Copy Anchor Link

protected notFoundError(id: string): Error;

Defined in: server/forms/form-schema-version-repository.ts:55

Create a not-found error. Override to provide custom error types.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Error

OverridesCopy Anchor Link

VersionRepository.notFoundError

softDelete()Copy Anchor Link

softDelete(id: string): Promise<void>;

Defined in: server/forms/form-schema-version-repository.ts:170

Soft-delete a version row (stamps deletedAt/deletedBy via auditDelete). VersionRepository is append-only and exposes no delete, so this is added directly. Every read on this repo filters deletedAt: null, so a soft-deleted version disappears from all reads.

Low-opinion by design — it does NOT guard publish/current state or cascade to child rows. The service layer (FormSchemaService.discardVersion) owns those guards and the step/transition cascade.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

update()Copy Anchor Link

update(id: string, patch: UpdateInput): Promise<{
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  entryStepKey: string | null;
  formSchemaId: string;
  id: string;
  publishedAt: Date | null;
  schema: JsonValue;
  versionNumber: number;
}>;

Defined in: server/forms/form-schema-version-repository.ts:145

Mutate a version's draft-stage fields and/or flip publishedAt. VersionRepository is append-only by default; this escape hatch is needed because Phase 02 promoted versions to a draft → published lifecycle. Callers must guard at the service layer to ensure published-version edits stay disallowed.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<{ changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; }>