okf_io library
File-system support for Open Knowledge Format bundles.
Classes
- OkfAttester
- The deterministic check for an Attested Computation receipt.
- OkfBundle
- A platform-independent, in-memory OKF knowledge bundle.
- OkfBundleApplication
- The result of serially preparing and applying one change set.
- OkfBundleApplicationRefused
- A candidate refused because it contains a Spec error.
- OkfBundleApplied
- A conformant candidate that was committed.
- OkfBundleChange
- A prospective mutation included in an OkfBundleChangeSet.
- OkfBundleChangeApplier
- Prepares and commits the single safe write path for OKF bundle mutations.
- OkfBundleChangeSet
- An ordered group of changes validated and applied as one operation.
- OkfBundleCommitResult
- OkfBundleLoader
- Loads OKF bundles from an explicitly supplied filesystem root.
- OkfBundleLoadResult
- The result of inspecting an OKF bundle directory.
- OkfBundlePreparation
- OkfBundleWriter
- Writes files beneath an explicit OKF bundle root.
- OkfComputationContract
- Typed view over an Attested Computation's top-level contract fields.
- OkfComputationParameter
- One declared, runtime-specific computation parameter.
- OkfConceptId
-
The bundle-relative path of an OKF concept, without the
.mdsuffix. - OkfCreateConceptChange
- A request to create a concept from a complete document.
- OkfDeprecateConceptChange
- A request to deprecate an existing concept.
- OkfDocument
- An Open Knowledge Format document: YAML frontmatter and a Markdown body.
- OkfExecutor
- Instructions for running an Attested Computation.
- OkfFinding
- A single observation produced while loading or validating a bundle.
- OkfFindingId
-
A stable finding identifier in
<namespace>/<code>form. - OkfFindingLocation
- A reported source position associated with a bundle.
- OkfGeneration
- How the current content was generated.
- OkfGraph
- A deterministic graph derived from concept links and path-valued fields.
- OkfGraphEdge
- A directed relationship originating at an OKF concept.
- OkfGraphNode
- A concept node in an OkfGraph.
- OkfGraphQuery
- Composable filters for constructing an OkfGraph.
- OkfIndexDocument
-
The parsed content of an OKF
index.mddocument. - OkfIndexEntry
-
One entry in an OKF
index.mddocument. - OkfIndexGenerator
-
Generates deterministic, progressively disclosed
index.mdfiles. - OkfIndexParseResult
- Parsed index data that may describe malformed, non-writable input.
- OkfLegacyCitation
-
One entry from a legacy v0.1
# Citationssection. - OkfLinkConceptsChange
- A request to add a typed relationship between concepts.
- OkfLogDocument
-
The parsed content of an OKF
log.mddocument. - OkfLogEntry
-
One dated entry in an OKF
log.mddocument. - OkfLogParseResult
- Parsed log data that may describe malformed, non-writable input.
- OkfMcpServer
- The OKF tool surface served over the Model Context Protocol.
- OkfMetadata
- An order-preserving typed view over open OKF frontmatter.
- OkfPreparationReady
- OkfPreparationRefused
- OkfPreparedCandidate
- An immutable view of the complete candidate prepared for a bundle write.
- OkfPreparedChange
- Opaque proof that an exact candidate passed OKF Spec validation.
- OkfReport
- The immutable findings produced while loading and validating a bundle.
- OkfSource
- A material from which an OKF concept was derived.
- OkfSpecRuleDescriptor
- Read-only metadata describing one fixed OKF Spec rule.
- OkfSpecValidation
- The closed OKF Spec judgment for one complete candidate bundle.
- OkfSpecValidator
- Checks the pinned OKF v0.2 requirements with a fixed internal rule set.
- OkfUpdateConceptChange
- A request to update the managed portions of an existing concept.
- OkfUsageWindow
- A date range framing one or more source usage counts.
- OkfVerdict
- An adapter's local exit judgment over an OKF Spec report.
- OkfVerification
- An event that confirmed a concept against its source or resource.
- OkfWriteResult
- The outcome of writing or checking a set of bundle files.
- OkfYamlEmitter
-
A small deterministic YAML emitter for values returned by
package:yaml.
Enums
- OkfExitCode
- Process outcomes owned by the finding contract.
- OkfFindingSeverity
- How a finding affects conformance.
- OkfGraphEdgeOrigin
- Where a graph relationship was discovered.
- OkfGraphResolution
- How an edge target was classified.
- OkfIndexIssue
-
A structural problem in an OKF
index.mddocument. - OkfLifecycleStatus
- The lifecycle state of an OKF concept.
- OkfLogIssue
-
A structural problem in an OKF
log.mddocument. - OkfTrustTier
- A trust tier derived from verification events.
Constants
- okfGraphJsonSchemaVersion → const String
- Current schema version emitted by OkfGraph.toJson.
-
okfKnownFrontmatterKeys
→ const Set<
String> - Frontmatter keys defined by OKF v0.2, including the v0.1 fallback key.
-
okfPreferredFrontmatterKeyOrder
→ const List<
String> - Preferred top-level frontmatter order used by OKF producer tooling.
Properties
-
okfSpecRuleDescriptors
→ List<
OkfSpecRuleDescriptor> -
Read-only metadata for the complete fixed OKF Spec finding set.
final
Typedefs
-
OkfDirectoryDescriptionSynthesizer
= String Function(String directory, List<
OkfIndexEntry> entries) - Supplies a deterministic description for a directory index.
- OkfDocumentError = OkfDocumentException
- Backward-friendly short name for document parsing failures.
Exceptions / Errors
- OkfBundleChangeException
- A change that cannot be described against the bundle it targets.
- OkfBundleLoadException
- Thrown by OkfBundleLoader.load when inspection finds malformed files.
- OkfDocumentException
- A failure to split or parse an OKF concept document.
- OkfStalePreparedChangeException
- OkfWriteRollbackException
- A write failed and one or more compensating filesystem operations failed.
- OkfYamlEncodeException
- A value could not be represented by the deterministic YAML emitter.