Skip to content
Speculator

SpecConfig

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

Normalized spec configuration

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

Properties

Section titled “Properties”

abstract?

Section titled “abstract?”

optional abstract: string

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

Abstract text (if not in document body)

authors?

Section titled “authors?”

optional authors: PersonEntry[]

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

Author list

baseUrl?

Section titled “baseUrl?”

optional baseUrl: string

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

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

Section titled “copyright?”

optional copyright: string

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

Copyright notice

creationDate?

Section titled “creationDate?”

optional creationDate: string

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

Original creation date (ISO 8601: YYYY-MM-DD)

custom?

Section titled “custom?”

optional custom: Record<string, unknown>

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

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

deps

Section titled “deps”

deps: string[]

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

Dependencies (empty array if none)

editors?

Section titled “editors?”

optional editors: PersonEntry[]

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

Editor list

group?

Section titled “group?”

optional group: string | GroupConfig

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

Group/organization information

id

Section titled “id”

id: string

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

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

jsonLd?

Section titled “jsonLd?”

optional jsonLd: object

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

JSON-LD metadata configuration

contexts?

Section titled “contexts?”

optional contexts: Record<string, string>

Standard contexts to include

vocab?

Section titled “vocab?”

optional vocab: string

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

lastUpdateDate?

Section titled “lastUpdateDate?”

optional lastUpdateDate: string

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

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

latestVersion?

Section titled “latestVersion?”

optional latestVersion: string

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

Latest version URL

license?

Section titled “license?”

optional license: string

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

License URL or identifier

localBiblio?

Section titled “localBiblio?”

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:292

Local bibliography entries for citation resolution

logos?

Section titled “logos?”

optional logos: object[]

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

Header logo configuration

alt?

Section titled “alt?”

optional alt: string

href?

Section titled “href?”

optional href: string

src

Section titled “src”

src: string

maturityLevel?

Section titled “maturityLevel?”

optional maturityLevel: MaturityLevel

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

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

maxTocLevel?

Section titled “maxTocLevel?”

optional maxTocLevel: number

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

Maximum ToC depth

previousVersion?

Section titled “previousVersion?”

optional previousVersion: string

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

Previous version URL

publishDate?

Section titled “publishDate?”

optional publishDate: string

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

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

repository?

Section titled “repository?”

optional repository: string | RepositoryConfig

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

Repository information

shortName?

Section titled “shortName?”

optional shortName: string

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

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

specIri

Section titled “specIri”

specIri: string

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

This version URL

specProfile?

Section titled “specProfile?”

optional specProfile: string

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

Custom specification profile/variant

status?

Section titled “status?”

optional status: string

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

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

subtitle?

Section titled “subtitle?”

optional subtitle: string

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

Subtitle or tagline

title?

Section titled “title?”

optional title: string

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

Document title

tocEnabled?

Section titled “tocEnabled?”

optional tocEnabled: boolean

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

Enable table of contents generation

version?

Section titled “version?”

optional version: string

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

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

xref?

Section titled “xref?”

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

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

External reference configuration