Skip to content

SpecConfig

Defined in: packages/speculator/src/preprocess/types.ts:188

Normalized spec configuration

Internal representation derived from ReSpec-like config files. All optional fields have sensible defaults applied.

optional abstract: string

Defined in: packages/speculator/src/preprocess/types.ts:244

Abstract text (if not in document body)


optional authors: PersonEntry[]

Defined in: packages/speculator/src/preprocess/types.ts:241

Author list


optional baseUrl: string

Defined in: packages/speculator/src/preprocess/types.ts:223

Base URL for assembling thisVersion (e.g., https://example.org/specs/)


optional copyright: string

Defined in: packages/speculator/src/preprocess/types.ts:247

Copyright notice


optional custom: Record<string, unknown>

Defined in: packages/speculator/src/preprocess/types.ts:279

Custom user-defined properties. Highest priority - overwrites both root and respec values.


deps: string[]

Defined in: packages/speculator/src/preprocess/types.ts:193

Dependencies (empty array if none)


optional editors: PersonEntry[]

Defined in: packages/speculator/src/preprocess/types.ts:238

Editor list


optional group: string | GroupConfig

Defined in: packages/speculator/src/preprocess/types.ts:235

Group/organization information


id: string

Defined in: packages/speculator/src/preprocess/types.ts:190

Document ID (from config.json or auto-generated)


optional jsonLd: object

Defined in: packages/speculator/src/preprocess/types.ts:285

JSON-LD metadata configuration

optional contexts: Record<string, string>

Standard contexts to include

optional vocab: string

Base IRI for the specification vocabulary (default: https://speculator.openuji.org/vocab#)


optional lastUpdateDate: string

Defined in: packages/speculator/src/preprocess/types.ts:214

Last update date (ISO 8601: YYYY-MM-DD)


optional latestVersion: string

Defined in: packages/speculator/src/preprocess/types.ts:226

Latest version URL


optional license: string

Defined in: packages/speculator/src/preprocess/types.ts:250

License URL or identifier


optional localBiblio: Record<string, { authors?: string[]; date?: string; publisher?: string; raw?: string; status?: string; title: string; url?: string; }>

Defined in: packages/speculator/src/preprocess/types.ts:265

Local bibliography entries for citation resolution


optional logos: object[]

Defined in: packages/speculator/src/preprocess/types.ts:253

Header logo configuration

optional alt: string

optional href: string

src: string


optional maturityLevel: MaturityLevel

Defined in: packages/speculator/src/preprocess/types.ts:208

Maturity level (priority: root maturityLevel > respec.specStatus)


optional maxTocLevel: number

Defined in: packages/speculator/src/preprocess/types.ts:259

Maximum ToC depth


optional noConformance: boolean

Defined in: packages/speculator/src/preprocess/types.ts:282

If true, suppresses the automatic generation of the conformance section.


optional previousVersion: string

Defined in: packages/speculator/src/preprocess/types.ts:229

Previous version URL


optional publishDate: string

Defined in: packages/speculator/src/preprocess/types.ts:211

Publication date (ISO 8601: YYYY-MM-DD)


optional repository: string | RepositoryConfig

Defined in: packages/speculator/src/preprocess/types.ts:232

Repository information


optional shortName: string

Defined in: packages/speculator/src/preprocess/types.ts:199

Short name for URLs/references (e.g., “html”, “css-grid”)


specIri: string

Defined in: packages/speculator/src/preprocess/types.ts:220

This version URL


optional specProfile: string

Defined in: packages/speculator/src/preprocess/types.ts:262

Custom specification profile/variant


optional status: string

Defined in: packages/speculator/src/preprocess/types.ts:205

Spec status (e.g., “ED”, “WD”, “CR”, “REC”, “NOTE”) - fallback if maturityLevel not set


optional subtitle: string

Defined in: packages/speculator/src/preprocess/types.ts:202

Subtitle or tagline


optional title: string

Defined in: packages/speculator/src/preprocess/types.ts:196

Document title


optional tocEnabled: boolean

Defined in: packages/speculator/src/preprocess/types.ts:256

Enable table of contents generation


optional version: string

Defined in: packages/speculator/src/preprocess/types.ts:217

Version string (e.g., “1.0.0”)


optional xref: string | string[] | Record<string, string>

Defined in: packages/speculator/src/preprocess/types.ts:293

External reference configuration