End-to-End Example: Compliance Audit Pack (Complex)

This example shows discriminated intent extraction, reference links, and custom error maps for audit-ready markdown.

Input Markdown

# AUDIT PACK: Checkout Risk Controls

## 0. META

- audit: PCI-DSS
- cycle: 2026-Q1

## 1. OWNERS

- Security: Priya N.
- Risk: Lucas M.

## 2. CONTROLS

### Evidence Collection

**TYPE:** POLICY

**TEXT:** Policy documents are versioned and immutable.

### Runtime Monitoring

**TYPE:** METRIC

**TEXT:** p95 scoring latency and citation coverage are monitored.

## 3. REFERENCES

Use [Policy Baseline][policy] and [Latency Dashboard](https://example.com/latency "Latency").

[policy]: https://example.com/policy-baseline "Policy Baseline"

Schema

import { md } from '@markschema/mdshape'

const controlSchema = md.object({
  title: md.headingText(),
  intent: md.match
    .labels(['TYPE', 'TEXT'])
    .entries({ nameKey: 'name', contentKey: 'value' })
    .each(
      md.discriminatedUnion('name', [
        md.object({ name: md.literal('TYPE'), value: md.enum(['POLICY', 'METRIC', 'PROCESS']) }),
        md.object({ name: md.literal('TEXT'), value: md.string().min(20) }),
      ]),
    )
    .min(2),
})

const schema = md
  .document({
    title: md.heading(1).regex(/^AUDIT PACK:\s.+/),
    meta: md.section('0. META').fields({
      audit: md.string().min(3),
      cycle: md.string().min(3),
    }),
    owners: md.section('1. OWNERS').fields({
      Security: md.string().min(3),
      Risk: md.string().min(3),
    }),
    controls: md.section('2. CONTROLS').subsections(3).each(controlSchema).min(2),
    references: md
      .section('3. REFERENCES')
      .referenceLinks(
        md.object({
          text: md.string().min(2),
          identifier: md.string().min(2),
          url: md.url(),
          title: md.string().optional(),
        }),
      )
      .min(1),
  })
  .errorMap((issue) => {
    if (issue.code === 'missing_section') return 'Required audit section missing'
    return issue.message
  })

Result

Success

{
  "success": true,
  "data": {
    "title": "AUDIT PACK: Checkout Risk Controls",
    "meta": {
      "audit": "PCI-DSS",
      "cycle": "2026-Q1"
    },
    "owners": {
      "Security": "Priya N.",
      "Risk": "Lucas M."
    },
    "controls": [
      {
        "title": "Evidence Collection",
        "intent": [
          {
            "name": "TYPE",
            "value": "POLICY"
          },
          {
            "name": "TEXT",
            "value": "Policy documents are versioned and immutable."
          }
        ]
      },
      {
        "title": "Runtime Monitoring",
        "intent": [
          {
            "name": "TYPE",
            "value": "METRIC"
          },
          {
            "name": "TEXT",
            "value": "p95 scoring latency and citation coverage are monitored."
          }
        ]
      }
    ],
    "references": [
      {
        "text": "Policy Baseline",
        "identifier": "policy",
        "url": "https://example.com/policy-baseline",
        "title": "Policy Baseline"
      }
    ]
  }
}

Error

Failure trigger: The input violates one or more constraints declared in the schema; use issues[].path and issues[].code to locate the exact failing node.

{
  "success": false,
  "error": {
    "issues": [
      {
        "code": "missing_heading",
        "message": "Missing heading with depth 1",
        "path": [
          "title"
        ],
        "line": 1,
        "position": {
          "start": {
            "line": 1,
            "column": 1
          }
        }
      }
    ]
  }
}