Interface TClaimLibraryManagement<TClaim>

Full management interface for a versioned claim library. Extends TClaimLookup with mutation, query, and snapshot methods.

interface TClaimLibraryManagement<TClaim extends TCoreClaim = TCoreClaim> {
    create(
        claim:
            | Omit<TClaim, "version" | "checksum" | "frozen">
            | Omit<TClaim, "version" | "checksum" | "id" | "frozen"> & {
                id?: string;
            },
    ): TClaim;
    freeze(id: string): { current: TClaim; frozen: TClaim };
    get(id: string, version: number): TClaim | undefined;
    getAll(): TClaim[];
    getCurrent(id: string): TClaim | undefined;
    getVersions(id: string): TClaim[];
    snapshot(): TClaimLibrarySnapshot<TClaim>;
    update(
        id: string,
        updates: Partial<Omit<TClaim, "id" | "version" | "frozen" | "checksum">>,
    ): TClaim;
    validate(): TInvariantValidationResult;
}

Type Parameters

TClaim extends TCoreClaim = TCoreClaim

Hierarchy (View Summary)

TClaimLookup<TClaim>
- TClaimLibraryManagement

Implemented by

ClaimLibrary

Index

Methods

create freeze get getAll getCurrent getVersions snapshot update validate

Methods

create

create(
    claim:
        | Omit<TClaim, "version" | "checksum" | "frozen">
        | Omit<TClaim, "version" | "checksum" | "id" | "frozen"> & { id?: string },
): TClaim
Creates a new claim at version 0. The version, frozen, and checksum fields are assigned automatically. The id field is auto-generated when omitted. The type field is required and is immutable across the claim's lifetime.
Parameters
- claim:
  | Omit<TClaim, "version" | "checksum" | "frozen">
  | Omit<TClaim, "version" | "checksum" | "id" | "frozen"> & { id?: string }
  The claim data without system-managed fields. id is optional (auto-generated when omitted) and type is required.
Returns TClaim
The created claim entity with all fields populated.

Throws
If a claim with the same ID already exists.
- Defined in src/lib/core/interfaces/library.interfaces.ts:70

freeze

freeze(id: string): { current: TClaim; frozen: TClaim }
Freezes the current version of a claim (marking it immutable) and creates a new mutable version at version + 1.
Parameters
- id: string
  The claim ID.
Returns { current: TClaim; frozen: TClaim }
An object containing the frozen version and the new current (mutable) version.

Throws
If the claim does not exist.

Throws
If the current version is already frozen.
- Defined in src/lib/core/interfaces/library.interfaces.ts:104

get

get(id: string, version: number): TClaim | undefined
Returns a claim by ID and version, or undefined if not found.
Parameters
- id: string
  The claim ID.
- version: number
  The claim version number.
Returns TClaim | undefined
The claim entity, or undefined.
Inherited from TClaimLookup.get
- Defined in src/lib/core/interfaces/library.interfaces.ts:35

getAll

getAll(): TClaim[]
Returns all claim entities across all IDs and versions.

Returns TClaim[]
An array of all claim entities.
- Defined in src/lib/core/interfaces/library.interfaces.ts:119

getCurrent

getCurrent(id: string): TClaim | undefined
Returns the latest version of a claim, or undefined if not found.
Parameters
- id: string
  The claim ID.
Returns TClaim | undefined
The latest claim entity, or undefined.
Overrides TClaimLookup.getCurrent
- Defined in src/lib/core/interfaces/library.interfaces.ts:112

getVersions

getVersions(id: string): TClaim[]
Returns all versions of a claim sorted by version number ascending.
Parameters
- id: string
  The claim ID.
Returns TClaim[]
An array of claim entities, or an empty array if the ID does not exist.
- Defined in src/lib/core/interfaces/library.interfaces.ts:128

snapshot

snapshot(): TClaimLibrarySnapshot<TClaim>
Returns a serializable snapshot of all claims in the library.

Returns TClaimLibrarySnapshot<TClaim>
The claim library snapshot.
- Defined in src/lib/core/interfaces/library.interfaces.ts:135

update

update(
id: string,
updates: Partial<Omit<TClaim, "id" | "version" | "frozen" | "checksum">>,
): TClaim
Updates mutable fields on the current (latest, unfrozen) version of a claim. System-managed fields (id, version, frozen, checksum) cannot be updated.
Parameters
- id: string
  The claim ID.
- updates: Partial<Omit<TClaim, "id" | "version" | "frozen" | "checksum">>
  The fields to update.
Returns TClaim
The updated claim entity.

Throws
If the claim does not exist.

Throws
If the current version is frozen.
- Defined in src/lib/core/interfaces/library.interfaces.ts:89

validate

validate(): TInvariantValidationResult
Run invariant validation on the claim library.

Returns TInvariantValidationResult
The invariant validation result.
- Defined in src/lib/core/interfaces/library.interfaces.ts:142

Interface TClaimLibraryManagement<TClaim>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

create

Parameters

Returns TClaim

Throws

freeze

Parameters

Returns { current: TClaim; frozen: TClaim }

Throws

Throws

get

Parameters

Returns TClaim | undefined

getAll

Returns TClaim[]

getCurrent

Parameters

Returns TClaim | undefined

getVersions

Parameters

Returns TClaim[]

snapshot

Returns TClaimLibrarySnapshot<TClaim>

update

Parameters

Returns TClaim

Throws

Throws

validate

Returns TInvariantValidationResult

Settings

On This Page