@paraharness/fs

Variables

Variable	Description
fs	Frozen @paraharness/fs builder namespace (fs.*).
fsExecutors	Default frozen RuntimeExecutorRegistrySlice instance for @paraharness/fs.

Functions

Function	Description
collectFsTelemetry	Collects deduplicated filesRead and filesMutated arrays from observedEffects (fs:telemetry).
createFsAllowOnlyGuardBuilder	Compiles a passive FsAllowOnlyGuardNode (fs:allow-only) for fs.allowOnly(globs).
createFsAllowWriteGlobsLeaseDelta	Creates a serializable LeaseDelta unlocking writes to globs (fs.allowWriteGlobs(globs)).
createFsBoundaryGuardBuilder	Compiles a passive FsBoundaryGuardNode (fs:boundary-guard) for fs.boundaryGuard(partitionMap).
createFsCodingTools	Compiles the 5-tool workspace-jailed coding bundle (fs.codingTools(runner?)).
createFsEditToolDriver	Creates the workspace-jailed ToolDriver for FsEditToolNode (fs:edit / edit_file).
createFsExecutors	Creates a fresh RuntimeExecutorRegistrySlice registering all @paraharness/fs runtime executors and drivers.
createFsGlobMatcherBuilder	Compiles a passive FsGlobMatcherNode (fs:match-globs) for fs.matchGlobs(globs, mode).
createFsGlobSourceBuilder	Compiles a passive FsGlobSourceNode (fs:glob-source) for fs.glob(globPattern).
createFsGlobToolDriver	Creates the workspace-jailed ToolDriver for FsGlobToolNode (fs:glob / glob_files).
createFsGrepToolDriver	Creates the workspace-jailed ToolDriver for FsGrepToolNode (fs:grep / grep_files).
createFsInPartitionPredicate	Builds a ScopePredicate matching a specific partition in partitionMap (fs.inPartition).
createFsJsonlLessonStoreBuilder	Compiles a passive FsJsonlLessonStoreNode (fs:jsonl-lesson-store) for fs.jsonlLessonStore(options?).
createFsMaxFilesMutatedBuilder	Compiles a passive FsQuotaTripwireNode (fs:quota-tripwire) for fs.maxFilesMutated(count).
createFsPartitionMap	Compiles a passive FsPartitionMapNode (fs:partition-map) for fs.partitionMap(topology, mapping).
createFsProtectGuardBuilder	Compiles a passive FsProtectGuardNode (fs:protect) for fs.protect(globs).
createFsReadOnlyGuardBuilder	Compiles a passive FsReadOnlyGuardNode (fs:read-only) for fs.readOnly().
createFsReadOnlyTools	Compiles the 3-tool workspace-jailed read-only bundle (fs.readOnlyTools(runner?)).
createFsReadToolDriver	Creates the workspace-jailed ToolDriver for FsReadToolNode (fs:read / read_file).
createFsRegexCheckBuilder	Compiles a passive FsRegexCheckNode (fs:regex-check) for fs.regexCheck(id, options).
createFsRequireReadBeforeWriteGuardBuilder	Compiles a passive FsRequireReadBeforeWriteGuardNode (fs:require-read-before-write) for fs.requireReadBeforeWrite().
createFsScopedWriteGuardBuilder	Compiles a passive FsScopedWriteGuardNode (fs:scoped-write) for fs.scopedWrite(partitionMap).
createFsSecretLiteralsGuardBuilder	Compiles a passive FsSecretLiteralsGuardNode (fs:secret-literals) for fs.secretLiterals(patterns).
createFsTelemetryBuilder	Compiles a passive FsTelemetryCollectorNode (fs:telemetry) for fs.telemetry().
createFsTextSourceBuilder	Compiles a passive FsTextSourceNode (fs:text-source) for fs.text(filePath).
createFsWriteGuardBuilder	Compiles a passive FsWriteGuardNode (fs:write-guard) for fs.writeGuard(options).
createFsWriteToolDriver	Creates the workspace-jailed ToolDriver for FsWriteToolNode (fs:write / write_file).
evaluateFsAllowOnlyGuard	Evaluates an FsAllowOnlyGuardNode (fs:allow-only) against proposed tool effects (SPEC.md §4.3).
evaluateFsBoundaryGuard	Evaluates an FsBoundaryGuardNode (fs:boundary-guard) against proposed tool effects (SPEC.md §4.3).
evaluateFsGlobEffectMatcher	Evaluates an FsGlobMatcherNode (fs:match-globs) against a ToolEffect (SPEC.md §3.5 & §4.3).
evaluateFsProtectGuard	Evaluates an FsProtectGuardNode (fs:protect) against proposed tool effects (SPEC.md §4.3).
evaluateFsQuotaTripwire	Evaluates an FsQuotaTripwireNode (fs:quota-tripwire) after tool execution (SPEC.md §4.3).
evaluateFsReadOnlyGuard	Evaluates an FsReadOnlyGuardNode (fs:read-only) against proposed tool effects (SPEC.md §4.3).
evaluateFsRequireReadBeforeWriteGuard	Evaluates an FsRequireReadBeforeWriteGuardNode (fs:require-read-before-write) (SPEC.md §4.3).
evaluateFsScopedWriteGuard	Evaluates an FsScopedWriteGuardNode (fs:scoped-write) against ctx.activePartitions (SPEC.md §4.3).
evaluateFsSecretLiteralsGuard	Evaluates an FsSecretLiteralsGuardNode (fs:secret-literals) against proposedContent (SPEC.md §4.3).
evaluateFsWriteGuard	Evaluates an FsWriteGuardNode (fs:write-guard) against proposed tool effects (SPEC.md §3.5 & §4.3).
executeFsGlobSource	Loads all UTF-8 files matching node.pattern in lexicographical order for an FsGlobSourceNode (fs:glob-source).
executeFsRegexCheck	Evaluates an FsRegexCheckNode (fs:regex-check) strictly over mutated files matching targetGlobs (SPEC.md §4.3).
executeFsTextSource	Loads UTF-8 text and computes a SHA-256 hex digest for an FsTextSourceNode (fs:text-source).
extractFsViolatedPaths	Extracts deduplicated filesystem paths in first-seen order from a PolicyViolation (fs.violatedPaths(violation)).

Classes

Class	Description
FsJsonlLessonStore	Crash-safe hybrid filesystem LessonStore implementation (fs.jsonlLessonStore, SPEC.md §4.3).

Interfaces

Interface	Description
FsAdmitLessonParams	Admission parameters for FsJsonlLessonStore.admit.
FsAllowOnlyGuardNode	Passive AST node restricting filesystem writes strictly to an allowlist of globs (fs.allowOnly).
FsBoundaryGuardNode	Passive AST node blocking unapproved writes to partition boundaryGlobs (fs.boundaryGuard).
FsEditToolNode	Passive AST node for the workspace-jailed file editing tool (fs:edit).
FsGlobMatcherNode	Passive AST node matching FsToolEffect paths against POSIX glob patterns (fs.matchGlobs).
FsGlobSourceNode	Passive AST node loading multiple UTF-8 text files matching a glob pattern (fs.glob).
FsGlobToolNode	Passive AST node for the workspace-jailed file globbing tool (fs:glob).
FsGrepToolNode	Passive AST node for the workspace-jailed content search tool (fs:grep).
FsJsonlLessonStoreNode	Passive AST node configuring a host-root content-addressed JSON/JSONL lesson store (fs.jsonlLessonStore).
FsJsonlLessonStoreOptions	Configuration options for fs.jsonlLessonStore(options?).
FsNamespace	Declarative builder namespace (fs.*) for @paraharness/fs sources, partition maps, guards, tools, and stores.
FsPartitionMapNode	Passive AST node mapping logical TopologyNode partitions to physical filesystem globs (fs.partitionMap).
FsPartitionPathMapping	Member implementation globs and public boundary surface globs mapped to a single topology partition.
FsProtectGuardNode	Passive AST node protecting specific glob patterns from write mutations (fs.protect).
FsQueryCandidatesParams	Query parameters for FsJsonlLessonStore.queryCandidates.
FsQuotaTripwireNode	Passive AST node tripping when distinct mutated file paths in a session exceed maxFilesMutated (fs.maxFilesMutated).
FsReadOnlyGuardNode	Passive AST node denying all filesystem write operations (fs.readOnly).
FsReadToolNode	Passive AST node for the workspace-jailed file reading tool (fs:read).
FsRecordOutcomeParams	Single lesson outcome entry for FsJsonlLessonStore.recordOutcomes.
FsRegexCheckNode	Passive AST node evaluating a forbidden regex pattern across mutated files matching targetGlobs (fs.regexCheck).
FsRegexCheckOptions	Configuration options for fs.regexCheck(id, options).
FsRequireReadBeforeWriteGuardNode	Passive AST node requiring an existing file to be read in the session before it is edited or overwritten (fs.requireReadBeforeWrite).
FsScopedWriteGuardNode	Passive AST node restricting writes to the actor's active partitions (fs.scopedWrite).
FsSecretLiteralsGuardNode	Passive AST node scanning proposed file writes for hardcoded secret literals (fs.secretLiterals).
FsTelemetryCollectorNode	Passive AST node collecting distinct read and mutated file paths from FsToolEffect records (fs.telemetry).
FsTextSourceNode	Passive AST node loading UTF-8 text from a single file path (fs.text).
FsToolEffect	Domain-specific ToolEffect emitted by @paraharness/fs tools and workspace diffs (SPEC.md §4.3).
FsToolEffectAttributes	Structured filesystem attributes attached to an FsToolEffect descriptor.
FsWriteGuardNode	Passive AST node enforcing glob-based write allow/deny rules (fs.writeGuard).
FsWriteGuardOptions	Configuration options for fs.writeGuard(options).
FsWriteToolNode	Passive AST node for the workspace-jailed file writing tool (fs:write).

References

violatedPaths

Renames and re-exports extractFsViolatedPaths