footprintjs - v11.2.0
    Preparing search index...

    Module footprintjs/trace

    Engine recorders, recorder stores and structure walkers. Not the record.

    Record readers, types and runtime-ID grammar belong to foottrace; record path helpers belong to foottrace/paths, and record writers to foottrace/write. This door exports only engine-owned observer tools. Record symbols are never re-exported across the package boundary.

    BoundaryStateStore
    ControlDepRecorder

    Stateful accumulator that watches FlowRecorder events and answers "which decision allowed this stage to run?" Attach via executor.attachCombinedRecorder(recorder) (or attachFlowRecorder).

    InOutRecorder

    Stateful accumulator that watches FlowRecorder chart-boundary events (run start/end + subflow entry/exit) and pushes InOutEntry records to its composed SequenceStore (Convention 1 — one purpose per recorder).

    KeyedStore

    KeyedStore — concrete, composable 1:1 storage keyed by string id.

    QualityRecorder

    Pluggable observer for scope operations.

    SequenceStore

    SequenceStore — concrete, composable storage for ordered sequence data.

    TopologyRecorder

    Stateful accumulator that watches FlowRecorder events and maintains a live composition graph. Attach via executor.attachCombinedRecorder(recorder) — footprintjs detects the FlowRecorder method shape and routes events.

    ControlDecisionRecord

    One recorded decision/selection event (RFC-003 D5).

    ControlDepRecorderOptions
    InOutAttempts

    What it cost to get through a boundary: the attempts made inside it (at any depth) by series that retried, gave up or timed out — count, per outcome (timeout included), and how many of those series gave up (exhausted, declined, no-time-left).

    InOutEntry

    One half of a chart execution boundary. Entry/exit pairs share runtimeStageId.

    InOutRecorderOptions
    QualityEntry

    Per-step quality data stored by QualityRecorder.

    QualityFrame

    A single frame in the quality stack trace.

    QualityRecorderOptions

    Options for QualityRecorder.

    QualityStackTrace

    The full quality stack trace.

    StoredCaptureHistory

    Engine history whose storage evidence matched. Channels and native limitations retain their original meanings.

    Topology

    Snapshot of the composition graph.

    TopologyEdge

    A traversal transition between two nodes.

    TopologyNode

    A composition-significant point in the graph.

    TopologyRecorderOptions
    WalkerOptions
    InOutPhase
    QualityScoringFn

    Scoring function called at the end of each stage. Receives the runtimeStageId, stage event, and a summary of reads/writes. Return a score (0.0–1.0) and optional factors explaining the score.

    StoredCaptureResult
    TopologyIncomingKind

    How the traversal reached this node — drives consumer layout decisions.

    TopologyNodeKind

    The kind of composition unit a node represents.

    WalkerItem
    BRANCH_SEGMENT_MARKER

    The reserved marker separating a parent stage id from a branch index in a generated subflow path segment. Reserved from 9.14.0 forward — the builder refuses it in user-authored subflow ids and in addParallelForEach ids.

    ROOT_RUNTIME_STAGE_ID

    Synthetic runtimeStageId for the top-level run boundary pair.

    ROOT_SUBFLOW_ID

    Synthetic id for the top-level run's boundary pair.

    buildBranchSegment

    Build the generated subflow path segment for one parallelForEach branch.

    controlDepRecorder

    Factory — matches the topologyRecorder() / inOutRecorder() style.

    formatQualityTrace

    Format a QualityStackTrace as human-readable text.

    hasBranchSegmentMarker

    True when value contains the reserved marker anywhere.

    inOutRecorder

    Factory — matches the topologyRecorder() / narrative() style.

    isBranchSegment

    True when segment is a generated branch segment — i.e. it splits at the LAST marker into a non-empty parent id and a non-negative integer index.

    parseBranchSegment

    Decompose a generated branch segment back into its parts, or undefined when segment is not one.

    qualityTrace

    Build a quality stack trace by decorating a causal chain with scores. Root cause is the largest positive score drop across a recorded parent→child dependency with known scores. Ties retain the first edge in BFS node / parent order. This score comparison is a diagnostic hint, not proof of why quality fell.

    readStoredCapture

    Read authorized stored entries using Foottrace's sequence/gap checks, then validate FootPrint's opaque metadata. A receipt is a host-adapter assertion, not a signature. Callers still own storage authorization and trust. Never performs causal analysis or upgrades partial native capture to complete.

    topologyRecorder

    Factory — matches the narrative() / metrics() style.

    walkSubflowSpec

    Walk a subflow spec, yielding its structure as flat ordered items.