rescript-iof-xml

IOF XML 3.0 types and parser for ReScript. Covers CompetitorList, EntryList, StartList, CourseData, ResultList, and EventList document types.

Types and their fields are documented based on the official IOF XML 3.0 XSD. Hover any type or function in your editor to see the relevant XSD documentation.

API docs

Full API reference is available at rescript-iof-xml.pages.dev/api.

Installation

npm install --save-exact rescript-iof-xml

Add to rescript.json:

{
  "dependencies": ["rescript-iof-xml"]
}

Usage

let xml = "<EntryList>...</EntryList>"
switch IofXml.EntryList.parse(xml) {
| Ok(entryList) => Console.log(entryList)
| Error(msg) => Console.error(msg)
}

Highlights

• ResultList — parses PersonResult, TeamResult, and TeamMemberResult (relay). status fields use typed variant unions (resultStatus, splitTimeStatus, resultListStatus) instead of raw strings.
• Multi-race — PersonResult.results is an array (one entry per race leg), and ClassResult.courses is an array.
• Organisations — country is typed as {code, name} instead of a plain string.
• Persons — sex is a typed variant (Male | Female) with @as("M") / @as("F") for correct wire values.
• EventorExtensions — opt-in helper for reading the Eventor-specific data carried in <Extensions> elements (namespace http://eventor.orientering.se/iofxmlextensions) emitted by the Eventor REST API's /.../iofxml endpoints. Call EventorExtensions.fromElement(eventEl) on any <Event> or <Race> XML element to get a typed record with eventRaceId, startListExists, resultListExists, disciplines (an array — events/races can accommodate multiple), lightCondition and attributes (custom Eventor event attributes, each with an id and value).