Interface TOriginLibraryManagement<TDocument, TLink, TAnchor>

Full management surface of an origin library: the read-only lookup plus creation, removal, snapshotting, and validation.

interface TOriginLibraryManagement<
    TDocument extends TCoreOriginDocument = TCoreOriginDocument,
    TLink extends TCoreOriginLink = TCoreOriginLink,
    TAnchor extends TCoreOriginAnchor = TCoreOriginAnchor,
> {
    addAnchor(anchor: Omit<TAnchor, "checksum">): TAnchor;
    addDocument(document: Omit<TDocument, "checksum" | "digest">): TDocument;
    addLink(link: Omit<TLink, "checksum">): TLink;
    getAllAnchors(): TAnchor[];
    getAllDocuments(): TDocument[];
    getAllLinks(): TLink[];
    getAnchor(id: string): TAnchor | undefined;
    getAnchorsForArgument(
        argumentId: string,
        argumentVersion: number,
    ): TAnchor[];
    getAnchorsForTarget(
        targetType: "expression" | "premise" | "argument",
        targetId: string,
    ): TAnchor[];
    getDocument(id: string): TDocument | undefined;
    getLink(id: string): TLink | undefined;
    getLinksForArgument(argumentId: string, argumentVersion: number): TLink[];
    removeAnchor(id: string): TAnchor;
    removeDocument(id: string): TDocument;
    removeLink(id: string): TLink;
    snapshot(): TOriginLibrarySnapshot<TDocument, TLink, TAnchor>;
    validate(): TInvariantValidationResult;
}

Index

Methods

addAnchor addDocument addLink getAllAnchors getAllDocuments getAllLinks getAnchor getAnchorsForArgument getAnchorsForTarget getDocument getLink getLinksForArgument removeAnchor removeDocument removeLink snapshot validate

Methods

addAnchor

addAnchor(anchor: Omit<TAnchor, "checksum">): TAnchor
Records the span of a document that one argument part derives from.
Parameters
- anchor: Omit<TAnchor, "checksum">
Returns TAnchor
- Defined in src/lib/core/interfaces/library.interfaces.ts:303

addDocument

addDocument(document: Omit<TDocument, "checksum" | "digest">): TDocument
Creates a document. The supplied text is normalized and its SHA-256 digest computed by the library; neither is a caller input.
Parameters
- document: Omit<TDocument, "checksum" | "digest">
Returns TDocument
- Defined in src/lib/core/interfaces/library.interfaces.ts:299

addLink

addLink(link: Omit<TLink, "checksum">): TLink
Attaches a document to one argument version with a stance.
Parameters
- link: Omit<TLink, "checksum">
Returns TLink
- Defined in src/lib/core/interfaces/library.interfaces.ts:301

getAllAnchors

getAllAnchors(): TAnchor[]
Every anchor in the library.

Returns TAnchor[]
- Defined in src/lib/core/interfaces/library.interfaces.ts:315

getAllDocuments

getAllDocuments(): TDocument[]
Every document in the library.

Returns TDocument[]
- Defined in src/lib/core/interfaces/library.interfaces.ts:311

getAllLinks

getAllLinks(): TLink[]
Every link in the library.

Returns TLink[]
- Defined in src/lib/core/interfaces/library.interfaces.ts:313

getAnchor

getAnchor(id: string): TAnchor | undefined
Returns the anchor with the given ID, or undefined.
Parameters
- id: string
Returns TAnchor | undefined
Inherited from TOriginLookup.getAnchor
- Defined in src/lib/core/interfaces/library.interfaces.ts:268

getAnchorsForArgument

getAnchorsForArgument(argumentId: string, argumentVersion: number): TAnchor[]
Returns every anchor recorded against the given argument version.
Parameters
- argumentId: string
- argumentVersion: number
Returns TAnchor[]
Inherited from TOriginLookup.getAnchorsForArgument
- Defined in src/lib/core/interfaces/library.interfaces.ts:272

getAnchorsForTarget

getAnchorsForTarget(
targetType: "expression" | "premise" | "argument",
targetId: string,
): TAnchor[]
Returns every anchor pointing at one target — a claim expression, a premise, or the argument itself.
Parameters
- targetType: "expression" | "premise" | "argument"
- targetId: string
Returns TAnchor[]
Inherited from TOriginLookup.getAnchorsForTarget
- Defined in src/lib/core/interfaces/library.interfaces.ts:280

getDocument

getDocument(id: string): TDocument | undefined
Returns the document with the given ID, or undefined.
Parameters
- id: string
Returns TDocument | undefined
Inherited from TOriginLookup.getDocument
- Defined in src/lib/core/interfaces/library.interfaces.ts:264

getLink

getLink(id: string): TLink | undefined
Returns the link with the given ID, or undefined.
Parameters
- id: string
Returns TLink | undefined
Inherited from TOriginLookup.getLink
- Defined in src/lib/core/interfaces/library.interfaces.ts:266

getLinksForArgument

getLinksForArgument(argumentId: string, argumentVersion: number): TLink[]
Returns every link attached to the given argument version.
Parameters
- argumentId: string
- argumentVersion: number
Returns TLink[]
Inherited from TOriginLookup.getLinksForArgument
- Defined in src/lib/core/interfaces/library.interfaces.ts:270

removeAnchor

removeAnchor(id: string): TAnchor
Removes an anchor.
Parameters
- id: string
Returns TAnchor
- Defined in src/lib/core/interfaces/library.interfaces.ts:309

removeDocument

removeDocument(id: string): TDocument
Removes a document. Refuses while any link or anchor still references it.
Parameters
- id: string
Returns TDocument
- Defined in src/lib/core/interfaces/library.interfaces.ts:305

removeLink

removeLink(id: string): TLink
Removes a link.
Parameters
- id: string
Returns TLink
- Defined in src/lib/core/interfaces/library.interfaces.ts:307

snapshot

snapshot(): TOriginLibrarySnapshot<TDocument, TLink, TAnchor>
Serializable snapshot of the whole library.

Returns TOriginLibrarySnapshot<TDocument, TLink, TAnchor>
- Defined in src/lib/core/interfaces/library.interfaces.ts:317

validate

validate(): TInvariantValidationResult
Checks every entity against the schema and the library's invariants.

Returns TInvariantValidationResult
- Defined in src/lib/core/interfaces/library.interfaces.ts:319

Interface TOriginLibraryManagement<TDocument, TLink, TAnchor>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

addAnchor

Parameters

Returns TAnchor

addDocument

Parameters

Returns TDocument

addLink

Parameters

Returns TLink

getAllAnchors

Returns TAnchor[]

getAllDocuments

Returns TDocument[]

getAllLinks

Returns TLink[]

getAnchor

Parameters

Returns TAnchor | undefined

getAnchorsForArgument

Parameters

Returns TAnchor[]

getAnchorsForTarget

Parameters

Returns TAnchor[]

getDocument

Parameters

Returns TDocument | undefined

getLink

Parameters

Returns TLink | undefined

getLinksForArgument

Parameters

Returns TLink[]

removeAnchor

Parameters

Returns TAnchor

removeDocument

Parameters

Returns TDocument

removeLink

Parameters

Returns TLink

snapshot

Returns TOriginLibrarySnapshot<TDocument, TLink, TAnchor>

validate

Returns TInvariantValidationResult

Settings

On This Page