Interface TVariableManagement<TArg, TPremise, TExpr, TVar>

Variable CRUD and lookup across the argument.

interface TVariableManagement<
    TArg extends TCoreArgument = TCoreArgument,
    TPremise extends TCorePremise = TCorePremise,
    TExpr extends TCorePropositionalExpression = TCorePropositionalExpression,
    TVar extends TCorePropositionalVariable = TCorePropositionalVariable,
> {
    addVariable(
        variable: Omit<
            {
                argumentId: string;
                argumentVersion: number;
                checksum: string;
                claimId: string;
                claimVersion: number;
                id: string;
                symbol: string;
            },
            "checksum"
            | "descendantChecksum"
            | "combinedChecksum",
        > & Partial<
            Pick<
                {
                    argumentId: string;
                    argumentVersion: number;
                    checksum: string;
                    claimId: string;
                    claimVersion: number;
                    id: string;
                    symbol: string;
                },
                "checksum",
            >,
        > & Record<string, unknown>,
    ): TCoreMutationResult<TVar, TExpr, TVar, TPremise, TArg>;
    bindVariableToPremise(
        variable: Omit<
            {
                argumentId: string;
                argumentVersion: number;
                boundArgumentId: string;
                boundArgumentVersion: number;
                boundPremiseId: string;
                checksum: string;
                id: string;
                symbol: string;
            },
            "checksum"
            | "descendantChecksum"
            | "combinedChecksum",
        > & Partial<
            Pick<
                {
                    argumentId: string;
                    argumentVersion: number;
                    boundArgumentId: string;
                    boundArgumentVersion: number;
                    boundPremiseId: string;
                    checksum: string;
                    id: string;
                    symbol: string;
                },
                "checksum",
            >,
        > & Record<string, unknown>,
    ): TCoreMutationResult<TVar, TExpr, TVar, TPremise, TArg>;
    buildVariableIndex<K>(keyFn: (v: TVar) => K): Map<K, TVar>;
    ensureClaimBoundVariable(
        claimId: string,
    ): {
        argumentId: string;
        argumentVersion: number;
        checksum: string;
        claimId: string;
        claimVersion: number;
        id: string;
        symbol: string;
    };
    getVariable(variableId: string): TVar | undefined;
    getVariableBySymbol(symbol: string): TVar | undefined;
    getVariables(): TVar[];
    getVariablesBoundToPremise(premiseId: string): TVar[];
    hasVariable(variableId: string): boolean;
    removeVariable(
        variableId: string,
    ): TCoreMutationResult<TVar | undefined, TExpr, TVar, TPremise, TArg>;
    updateVariable(
        variableId: string,
        updates: Record<string, unknown>,
    ): TCoreMutationResult<TVar | undefined, TExpr, TVar, TPremise, TArg>;
}

Type Parameters

TArg extends TCoreArgument = TCoreArgument
TPremise extends TCorePremise = TCorePremise
TExpr extends TCorePropositionalExpression = TCorePropositionalExpression
TVar extends TCorePropositionalVariable = TCorePropositionalVariable

Implemented by

ArgumentEngine

Index

Methods

addVariable bindVariableToPremise buildVariableIndex ensureClaimBoundVariable getVariable getVariableBySymbol getVariables getVariablesBoundToPremise hasVariable removeVariable updateVariable

Methods

addVariable

addVariable(
    variable: Omit<
        {
            argumentId: string;
            argumentVersion: number;
            checksum: string;
            claimId: string;
            claimVersion: number;
            id: string;
            symbol: string;
        },
        "checksum"
        | "descendantChecksum"
        | "combinedChecksum",
    > & Partial<
        Pick<
            {
                argumentId: string;
                argumentVersion: number;
                checksum: string;
                claimId: string;
                claimVersion: number;
                id: string;
                symbol: string;
            },
            "checksum",
        >,
    > & Record<string, unknown>,
): TCoreMutationResult<TVar, TExpr, TVar, TPremise, TArg>
Registers a propositional variable for use across all premises.
Parameters
- variable: Omit<
      {
          argumentId: string;
          argumentVersion: number;
          checksum: string;
          claimId: string;
          claimVersion: number;
          id: string;
          symbol: string;
      },
      "checksum"
      | "descendantChecksum"
      | "combinedChecksum",
  > & Partial<
      Pick<
          {
              argumentId: string;
              argumentVersion: number;
              checksum: string;
              claimId: string;
              claimVersion: number;
              id: string;
              symbol: string;
          },
          "checksum",
      >,
  > & Record<string, unknown>
  The variable entity to register.
Returns TCoreMutationResult<TVar, TExpr, TVar, TPremise, TArg>
The registered variable (with checksum) and changeset.

Throws
If variable.symbol is already in use.

Throws
If variable.id already exists.

Throws
If the variable does not belong to this argument.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:237

bindVariableToPremise

bindVariableToPremise(
    variable: Omit<
        {
            argumentId: string;
            argumentVersion: number;
            boundArgumentId: string;
            boundArgumentVersion: number;
            boundPremiseId: string;
            checksum: string;
            id: string;
            symbol: string;
        },
        "checksum"
        | "descendantChecksum"
        | "combinedChecksum",
    > & Partial<
        Pick<
            {
                argumentId: string;
                argumentVersion: number;
                boundArgumentId: string;
                boundArgumentVersion: number;
                boundPremiseId: string;
                checksum: string;
                id: string;
                symbol: string;
            },
            "checksum",
        >,
    > & Record<string, unknown>,
): TCoreMutationResult<TVar, TExpr, TVar, TPremise, TArg>
Registers a premise-bound propositional variable whose truth value is derived from another premise's evaluation.
Parameters
- variable: Omit<
      {
          argumentId: string;
          argumentVersion: number;
          boundArgumentId: string;
          boundArgumentVersion: number;
          boundPremiseId: string;
          checksum: string;
          id: string;
          symbol: string;
      },
      "checksum"
      | "descendantChecksum"
      | "combinedChecksum",
  > & Partial<
      Pick<
          {
              argumentId: string;
              argumentVersion: number;
              boundArgumentId: string;
              boundArgumentVersion: number;
              boundPremiseId: string;
              checksum: string;
              id: string;
              symbol: string;
          },
          "checksum",
      >,
  > & Record<string, unknown>
  The premise-bound variable entity to register.
Returns TCoreMutationResult<TVar, TExpr, TVar, TPremise, TArg>
The registered variable (with checksum) and changeset.

Throws
If variable.symbol is already in use.

Throws
If variable.id already exists.

Throws
If variable.boundPremiseId does not exist in this argument.

Throws
If variable.boundArgumentId does not match this argument.

Throws
If the variable does not belong to this argument.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:253

buildVariableIndex

buildVariableIndex<K>(keyFn: (v: TVar) => K): Map<K, TVar>
Builds a Map keyed by a caller-supplied function over all variables. Useful for indexing by extension fields (e.g. statementId). The caller should cache the result — this is O(n) per call.
Type Parameters
- K
Parameters
- keyFn: (v: TVar) => K
  A function that extracts the map key from a variable.
Returns Map<K, TVar>
A Map from the extracted key to the variable.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:322

ensureClaimBoundVariable

ensureClaimBoundVariable(
    claimId: string,
): {
    argumentId: string;
    argumentVersion: number;
    checksum: string;
    claimId: string;
    claimVersion: number;
    id: string;
    symbol: string;
}
Idempotent lookup-or-create for a claim-bound variable. If a claim-bound variable for claimId already exists in this argument, it is returned as-is. Otherwise a new variable is created with a fresh UUID, the current version of the claim from the ClaimLibrary, and an auto-generated symbol.

This method is used internally by derivation premise initialization but is also available to callers that need to pin a claim as a propositional variable without creating a full premise.
Parameters
- claimId: string
  The ID of the claim to bind a variable to.
Returns {
    argumentId: string;
    argumentVersion: number;
    checksum: string;
    claimId: string;
    claimVersion: number;
    id: string;
    symbol: string;
}
The existing or newly created TClaimBoundVariable.

Throws
InvariantViolationError(CLAIM_NOT_FOUND) when claimId is not present in the claim library.

Since
0.11.0
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:350

getVariable

getVariable(variableId: string): TVar | undefined
Returns the variable with the given ID, or undefined if not found.
Parameters
- variableId: string
  The variable ID to look up.
Returns TVar | undefined
The variable entity, or undefined.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:292

getVariableBySymbol

getVariableBySymbol(symbol: string): TVar | undefined
Returns the variable with the given symbol, or undefined if not found.
Parameters
- symbol: string
  The symbol string to look up.
Returns TVar | undefined
The variable entity, or undefined.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:307

getVariables

getVariables(): TVar[]
Returns all registered variables sorted by ID.

Returns TVar[]
An array of variable entities.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:313

getVariablesBoundToPremise

getVariablesBoundToPremise(premiseId: string): TVar[]
Returns all premise-bound variables whose boundPremiseId matches the given premise ID. This is a linear scan over all variables.
Parameters
- premiseId: string
  The premise ID to filter by.
Returns TVar[]
An array of variables bound to the given premise.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:330

hasVariable

hasVariable(variableId: string): boolean
Returns true if a variable with the given ID exists.
Parameters
- variableId: string
  The variable ID to check.
Returns boolean
Whether the variable exists.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:299

removeVariable

removeVariable(
variableId: string,
): TCoreMutationResult<TVar | undefined, TExpr, TVar, TPremise, TArg>
Removes a variable and cascade-deletes all expressions referencing it across every premise (including subtrees and operator collapse).
Parameters
- variableId: string
  The ID of the variable to remove.
Returns TCoreMutationResult<TVar | undefined, TExpr, TVar, TPremise, TArg>
The removed variable, or undefined if not found.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:283

updateVariable

updateVariable(
variableId: string,
updates: Record<string, unknown>,
): TCoreMutationResult<TVar | undefined, TExpr, TVar, TPremise, TArg>
Updates fields on an existing variable. Since all premises share the same VariableManager, the update is immediately visible everywhere.
Parameters
- variableId: string
  The ID of the variable to update.
- updates: Record<string, unknown>
  Fields to update. For claim-bound variables: symbol, claimId, claimVersion. For premise-bound variables: symbol, boundPremiseId, boundArgumentId, boundArgumentVersion. claimId and claimVersion must be provided together on claim-bound variables.
Returns TCoreMutationResult<TVar | undefined, TExpr, TVar, TPremise, TArg>
The updated variable, or undefined if not found.

Throws
If the new symbol is already in use by a different variable.

Throws
If the new claim reference does not exist in the claim library.

Throws
If updates include fields from the wrong binding type (e.g., boundPremiseId on a claim-bound variable).

Throws
If the new boundPremiseId does not exist in this argument.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:272

Interface TVariableManagement<TArg, TPremise, TExpr, TVar>

Type Parameters

Implemented by

Index

Methods

Methods

addVariable

Parameters

Returns TCoreMutationResult<TVar, TExpr, TVar, TPremise, TArg>

Throws

Throws

Throws

bindVariableToPremise

Parameters

Returns TCoreMutationResult<TVar, TExpr, TVar, TPremise, TArg>

Throws

Throws

Throws

Throws

Throws

buildVariableIndex

Type Parameters

Parameters

Returns Map<K, TVar>

ensureClaimBoundVariable

Parameters

Returns { argumentId: string; argumentVersion: number; checksum: string; claimId: string; claimVersion: number; id: string; symbol: string;}

Throws

Since

getVariable

Parameters

Returns TVar | undefined

getVariableBySymbol

Parameters

Returns TVar | undefined

getVariables

Returns TVar[]

getVariablesBoundToPremise

Parameters

Returns TVar[]

hasVariable

Parameters

Returns boolean

removeVariable

Parameters

Returns TCoreMutationResult<TVar | undefined, TExpr, TVar, TPremise, TArg>

updateVariable

Parameters

Returns TCoreMutationResult<TVar | undefined, TExpr, TVar, TPremise, TArg>

Throws

Throws

Throws

Throws

Settings

On This Page

Returns {
argumentId: string;
argumentVersion: number;
checksum: string;
claimId: string;
claimVersion: number;
id: string;
symbol: string;
}