Class ClaimLibrary<TClaim>

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

Index

Constructors

constructor

new ClaimLibrary<
    TClaim extends
        {
            checksum: string;
            frozen: boolean;
            id: string;
            type: "normal"
            | "citation"
            | "axiomatic";
            version: number;
        } = {
        checksum: string;
        frozen: boolean;
        id: string;
        type: "normal"
        | "citation"
        | "axiomatic";
        version: number;
    },
>(
    options?: {
        checksumConfig?: TCoreChecksumConfig;
        generateId?: () => string;
    },
): ClaimLibrary<TClaim>
Type Parameters
- TClaim extends {
      checksum: string;
      frozen: boolean;
      id: string;
      type: "normal" | "citation" | "axiomatic";
      version: number;
  } = {
      checksum: string;
      frozen: boolean;
      id: string;
      type: "normal" | "citation" | "axiomatic";
      version: number;
  }
Parameters
- Optionaloptions: { checksumConfig?: TCoreChecksumConfig; generateId?: () => string }
Returns ClaimLibrary<TClaim>
Overrides VersionedLibrary.constructor
- Defined in src/lib/core/claim-library.ts:41

Properties

`Protected` `Optional`checksumConfig

checksumConfig?: TCoreChecksumConfig

`Protected` `Readonly`checksumFieldsKey

checksumFieldsKey: "claimFields" = ...

`Protected`entities

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

`Protected` `Readonly`entityLabel

entityLabel: "Claim"

`Protected` `Readonly`entityType

entityType: "claim" = ...

`Protected` `Readonly`frozenSuccessorCode

frozenSuccessorCode: "CLAIM_FROZEN_NO_SUCCESSOR" = CLAIM_FROZEN_NO_SUCCESSOR

`Protected` `Readonly`schema

schema: TObject<
    {
        checksum: TString;
        frozen: TBoolean;
        id: TString;
        type: TUnion<
            [TLiteral<"normal">, TLiteral<"citation">, TLiteral<"axiomatic">],
        >;
        version: TNumber;
    },
> = CoreClaimSchema

`Protected` `Readonly`schemaInvalidCode

schemaInvalidCode: "CLAIM_SCHEMA_INVALID" = CLAIM_SCHEMA_INVALID

Methods

create

create(input: TClaimCreateInput<TClaim>): TClaim
Creates a new claim at version 0. The type field is required and is immutable across the claim's lifetime. id is auto-generated when omitted.
Parameters
- input: TClaimCreateInput<TClaim>
Returns TClaim
Implementation of TClaimLibraryManagement.create
Overrides VersionedLibrary.create
- Defined in src/lib/core/claim-library.ts:53

freeze

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

get

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

getAll

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

Returns TClaim[]
Implementation of TClaimLibraryManagement.getAll
Inherited from VersionedLibrary.getAll
- Defined in src/lib/core/versioned-library.ts:179

getCurrent

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

getVersions

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

`Protected`restoreFromEntities

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

snapshot

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

Returns TClaimLibrarySnapshot<TClaim>
The claim library snapshot.
Implementation of TClaimLibraryManagement.snapshot
- Defined in src/lib/core/claim-library.ts:89

update

update(
id: string,
updates: Partial<Omit<TClaim, "id" | "version" | "frozen" | "checksum">>,
): TClaim
Applies partial updates to the latest version of a claim. Rejects any update that would change the immutable type field.
Parameters
- id: string
- updates: Partial<Omit<TClaim, "id" | "version" | "frozen" | "checksum">>
Returns TClaim
Implementation of TClaimLibraryManagement.update
Overrides VersionedLibrary.update
- Defined in src/lib/core/claim-library.ts:67

validate

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

Returns TInvariantValidationResult
Implementation of TClaimLibraryManagement.validate
Inherited from VersionedLibrary.validate
- Defined in src/lib/core/versioned-library.ts:199

`Protected`withValidation

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

`Static`fromSnapshot

fromSnapshot<
    TClaim extends
        {
            checksum: string;
            frozen: boolean;
            id: string;
            type: "normal"
            | "citation"
            | "axiomatic";
            version: number;
        } = {
        checksum: string;
        frozen: boolean;
        id: string;
        type: "normal"
        | "citation"
        | "axiomatic";
        version: number;
    },
>(
    snapshot: TClaimLibrarySnapshot<TClaim>,
    options?: {
        checksumConfig?: TCoreChecksumConfig;
        generateId?: () => string;
    },
): ClaimLibrary<TClaim>
Restores a claim library from a previously captured snapshot. Pre-screens for legacy (pre-v0.10.0) claim entries that lack the required type field and emits LEGACY_CLAIM_MISSING_TYPE so the caller gets a clear migration signal rather than a generic schema error.
Type Parameters
- TClaim extends {
      checksum: string;
      frozen: boolean;
      id: string;
      type: "normal" | "citation" | "axiomatic";
      version: number;
  } = {
      checksum: string;
      frozen: boolean;
      id: string;
      type: "normal" | "citation" | "axiomatic";
      version: number;
  }
Parameters
- snapshot: TClaimLibrarySnapshot<TClaim>
- Optionaloptions: { checksumConfig?: TCoreChecksumConfig; generateId?: () => string }
Returns ClaimLibrary<TClaim>
- Defined in src/lib/core/claim-library.ts:100

Class ClaimLibrary<TClaim>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ClaimLibrary<TClaim>

Properties

Protected OptionalchecksumConfig

Protected ReadonlychecksumFieldsKey

Protectedentities

Protected ReadonlyentityLabel

Protected ReadonlyentityType

Protected ReadonlyfrozenSuccessorCode

Protected Readonlyschema

Protected ReadonlyschemaInvalidCode

Methods

create

Parameters

Returns TClaim

freeze

Parameters

Returns { current: TClaim; frozen: TClaim }

get

Parameters

Returns TClaim | undefined

getAll

Returns TClaim[]

getCurrent

Parameters

Returns TClaim | undefined

getVersions

Parameters

Returns TClaim[]

ProtectedrestoreFromEntities

Parameters

Returns void

snapshot

Returns TClaimLibrarySnapshot<TClaim>

update

Parameters

Returns TClaim

validate

Returns TInvariantValidationResult

ProtectedwithValidation

Type Parameters

Parameters

Returns T

StaticfromSnapshot

Type Parameters

Parameters

Returns ClaimLibrary<TClaim>

Settings

On This Page

`Protected` `Optional`checksumConfig

`Protected` `Readonly`checksumFieldsKey

`Protected`entities

`Protected` `Readonly`entityLabel

`Protected` `Readonly`entityType

`Protected` `Readonly`frozenSuccessorCode

`Protected` `Readonly`schema

`Protected` `Readonly`schemaInvalidCode

`Protected`restoreFromEntities

`Protected`withValidation

`Static`fromSnapshot