Skip to content

Import map

Import a name from the door that owns it. FootPrint does not re-export the record, so its readers come straight from foottrace.

Each door links to its reference, which is generated from the code and lists every name. foottrace has its own docs.

Import fromWhat it is forCommon names
footprintjsThe main door: build, run, decide, retry, pause.flowChart, FlowChartExecutor, decide, select, narrative, attempt, exponentialBackoff, timeBudget, interrupt, TypedScope, RetryPolicy, FlowRecorder, CombinedRecorder
footprintjs/recordersRecorder factories.narrative, attempts, metrics, debug, manifest, adaptive, milestone, windowed, memoryStore, CompositeRecorder
footprintjs/traceEngine recorders, recorder stores and structure walkers. Not the record.controlDepRecorder, topologyRecorder, inOutRecorder, QualityRecorder, KeyedStore, SequenceStore, BoundaryStateStore, walkSubflowSpec
footprintjs/detachFire-and-forget child charts and their drivers.microtaskBatchDriver, immediateDriver, setTimeoutDriver, flushAllDetached, DetachHandle
footprintjs/sinksNode only. The crash-safe record as a JSON-lines file.fileSink, readRecordFile, openIndexedRecordFile
footprintjs/zodOpt-in zod scope helpers. zod is an optional peer.defineScopeFromZod, defineScopeSchema, ZodScopeResolver
footprintjs/advancedEngine internals. Use them to extend the engine, not to write a chart.ArrayMergeMode, SubflowMountOptions, StageSnapshot, ScopeFacade, registerScopeRuntime, SCOPE_METHOD_NAMES, StageContext, FlowchartTraverser
foottraceRead a record: shapes, runtime IDs, commit queries, slices, time travel, stored records.findLastWriter, findCommit, causalChain, formatCausalChain, sliceForKey, stateAt, timeTravel, readStoredRecord, parseRuntimeStageId, CommitBundle, HONESTY_CODES
foottrace/writeWrite a record yourself.SharedMemory, EventLog, RecordFrame, memorySink
foottrace/pathsRecord-path rules, safe nested access and diagnostic-bag writes.setNestedValue, updateNestedValue
foottrace/causeOptional bounded cause, impact and attention queries.explain, attentionList
foottrace/metadataOptional value-free queries over path occurrences.readTraceMetadata, traceMetadata
foottrace/provOptional export of one recorded scope as PROV-O, without values.exportProv

Use footprintjs/advanced to extend the engine. To write a chart, start at footprintjs.

This table comes from ai-instructions/source/import-map.json, the same source as AGENTS.md.