Class VersionedLibrary<TEntity>`Abstract`

Abstract base class for versioned, freezable entity libraries. Provides CRUD, freeze/unfreeze lifecycle, schema validation, and checksum computation. Subclasses supply the entity label, schema, and validation codes.

Type Parameters

TEntity extends TVersionedEntity

Hierarchy (View Summary)

VersionedLibrary
- ClaimLibrary

Index

Constructors

constructor

new VersionedLibrary<TEntity extends TVersionedEntity>(
options?: { checksumConfig?: TCoreChecksumConfig },
): VersionedLibrary<TEntity>
Type Parameters
- TEntity extends TVersionedEntity
Parameters
- Optionaloptions: { checksumConfig?: TCoreChecksumConfig }
Returns VersionedLibrary<TEntity>
- Defined in src/lib/core/versioned-library.ts:37

Properties

`Protected` `Optional`checksumConfig

checksumConfig?: TCoreChecksumConfig

`Protected` `Abstract` `Readonly`checksumFieldsKey

checksumFieldsKey: keyof TCoreChecksumConfig

`Protected`entities

entities: Map<string, Map<number, TEntity>>

`Protected` `Abstract` `Readonly`entityLabel

entityLabel: string

`Protected` `Abstract` `Readonly`entityType

entityType: TInvariantViolationEntityType

`Protected` `Abstract` `Readonly`frozenSuccessorCode

frozenSuccessorCode: string

`Protected` `Abstract` `Readonly`schema

schema: TSchema

`Protected` `Abstract` `Readonly`schemaInvalidCode

schemaInvalidCode: string

Methods

create

create(entity: Omit<TEntity, "version" | "frozen" | "checksum">): TEntity
Creates a new entity at version 0. Throws if the ID already exists.
Parameters
- entity: Omit<TEntity, "version" | "frozen" | "checksum">
Returns TEntity
- Defined in src/lib/core/versioned-library.ts:73

freeze

freeze(id: string): { current: TEntity; frozen: TEntity }
Freezes the latest version and creates a new mutable successor. Returns both.
Parameters
- id: string
Returns { current: TEntity; frozen: TEntity }
- Defined in src/lib/core/versioned-library.ts:131

get

get(id: string, version: number): TEntity | undefined
Returns a specific version of an entity, or undefined if not found.
Parameters
- id: string
- version: number
Returns TEntity | undefined
- Defined in src/lib/core/versioned-library.ts:167

getAll

getAll(): TEntity[]
Returns every entity across all IDs and versions.

Returns TEntity[]
- Defined in src/lib/core/versioned-library.ts:179

getCurrent

getCurrent(id: string): TEntity | undefined
Returns the latest (highest-version) entity for the given ID, or undefined if not found.
Parameters
- id: string
Returns TEntity | undefined
- Defined in src/lib/core/versioned-library.ts:172

getVersions

getVersions(id: string): TEntity[]
Returns all versions of an entity sorted ascending by version number.
Parameters
- id: string
Returns TEntity[]
- Defined in src/lib/core/versioned-library.ts:190

`Protected`restoreFromEntities

restoreFromEntities(items: TEntity[]): void
Parameters
- items: TEntity[]
Returns void
- Defined in src/lib/core/versioned-library.ts:42

update

update(
id: string,
updates: Partial<Omit<TEntity, "id" | "version" | "frozen" | "checksum">>,
): TEntity
Applies partial updates to the latest version of an entity. Throws if the entity is frozen.
Parameters
- id: string
- updates: Partial<Omit<TEntity, "id" | "version" | "frozen" | "checksum">>
Returns TEntity
- Defined in src/lib/core/versioned-library.ts:98

validate

validate(): TInvariantValidationResult
Validates all entities against the schema and checks that frozen versions have successors.

Returns TInvariantValidationResult
- Defined in src/lib/core/versioned-library.ts:199

`Protected`withValidation

withValidation<T>(fn: () => T): T
Type Parameters
- T
Parameters
- fn: () => T
Returns T
- Defined in src/lib/core/versioned-library.ts:54

Class VersionedLibrary<TEntity>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VersionedLibrary<TEntity>

Properties

Protected OptionalchecksumConfig

Protected Abstract ReadonlychecksumFieldsKey

Protectedentities

Protected Abstract ReadonlyentityLabel

Protected Abstract ReadonlyentityType

Protected Abstract ReadonlyfrozenSuccessorCode

Protected Abstract Readonlyschema

Protected Abstract ReadonlyschemaInvalidCode

Methods

create

Parameters

Returns TEntity

freeze

Parameters

Returns { current: TEntity; frozen: TEntity }

get

Parameters

Returns TEntity | undefined

getAll

Returns TEntity[]

getCurrent

Parameters

Returns TEntity | undefined

getVersions

Parameters

Returns TEntity[]

ProtectedrestoreFromEntities

Parameters

Returns void

update

Parameters

Returns TEntity

validate

Returns TInvariantValidationResult

ProtectedwithValidation

Type Parameters

Parameters

Returns T

Settings

On This Page

Class VersionedLibrary<TEntity>`Abstract`

`Protected` `Optional`checksumConfig

`Protected` `Abstract` `Readonly`checksumFieldsKey

`Protected`entities

`Protected` `Abstract` `Readonly`entityLabel

`Protected` `Abstract` `Readonly`entityType

`Protected` `Abstract` `Readonly`frozenSuccessorCode

`Protected` `Abstract` `Readonly`schema

`Protected` `Abstract` `Readonly`schemaInvalidCode

`Protected`restoreFromEntities

`Protected`withValidation