Rulvar API reference / @rulvar/rulvar / FinishContractManifest
Interface: FinishContractManifest
Defined in: packages/core/dist/index.d.ts
The single source of truth of a textual finish contract: what the prompt promises IS what the validators enforce. Declare only textual demands here (sections, length, citations); an object-shaped result belongs to requiredSectionsValidator's sibling requiredFieldsValidator and a host-provided selfTest accept fixture.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
citations? | FinishContractCitations | Citation demands over the result text. | packages/core/dist/index.d.ts |
fencedCode? | FencedCodeMode | Whether fenced code blocks count (cycle 74): 'counted' (the default) or 'excluded' (fenced code is removed before section matching, slicing, word counting, and citation matching, so code samples can neither satisfy a marker nor pad a count). Joins the hash and adds a prompt statement only when 'excluded'; an explicit 'counted' normalizes away. With 'excluded', a section marker or a citation sample that would itself OPEN a fence is a ConfigError, because the golden fixtures embed both at line starts. | packages/core/dist/index.d.ts |
sectionPatterns? | FinishContractSectionPattern[] | Counted collections inside named sections (RV2206): each entry demands at least min matches of pattern inside section's slice, DISTINCT by first capture when the pattern captures. Requires sections. The samples are literal matches embedded in the golden fixtures and quoted by the prompt: with a capturing pattern they must carry at least min DISTINCT captures, because the accept skeleton must itself satisfy the demand. | packages/core/dist/index.d.ts |
sections? | string[] | Literal section markers the result must contain. | packages/core/dist/index.d.ts |
sectionsMatch? | SectionMatchMode | How section markers must appear (cycle 74): 'anywhere' (the default, a plain substring test) or 'line' (each marker must stand as its own line, surrounding whitespace ignored, so a mid sentence mention no longer satisfies a heading). Requires sections. Joins the hash and the prompt statement only when 'line'; an explicit 'anywhere' normalizes away, keeping the hash of the plain manifest. | packages/core/dist/index.d.ts |
words? | { max?: number; min?: number; } | Word bounds over the result text (whitespace separated tokens). | packages/core/dist/index.d.ts |
words.max? | number | - | packages/core/dist/index.d.ts |
words.min? | number | - | packages/core/dist/index.d.ts |