Demo Kit
Run the canonical v2 pipeline against the corpus and show the current milestone in one sitting.
Demo Kit
This is the shortest honest demo path for v0.2.0-alpha.1.
The goal is not to claim regulator-ready submission. The goal is to show that SFRS now has a canonical, fact-centric pipeline that can:
- ingest XBRL into canonical
v2 - validate against the first supported profiles
- export back to
XBRLandiXBRL - package outputs with a manifest and checksums
- regression-test those behaviors against the corpus
Best Demo Flow
- Pick one corpus fixture.
- Parse it into canonical
v2. - Inspect facts, contexts, dimensions, footnotes, and relationships.
- Run canonical validation.
- Export to both
XBRLandiXBRL. - Generate a package manifest.
- Show the release-notes entry so the audience sees the support boundary.
Run The Demo Script
Build the packages the script depends on:
pnpm --filter @sureshake/sfrs-standard build
pnpm --filter @sureshake/sfrs-validator build
pnpm --filter @sureshake/sfrs-converter buildList available fixtures:
pnpm demo:canonical-v2 -- --listRun the full demo across the registered corpus:
pnpm demo:canonical-v2Run a single fixture and write generated artifacts:
pnpm demo:canonical-v2 -- \
--fixture sec-dimensional-linkbase \
--write-artifacts tmp/demoWhat The Script Shows
- fixture metadata from the corpus
- parse result and unmapped concept counts
- canonical filing summary: contexts, units, facts, footnotes, relationships
- validation summary: errors, warnings, info
- output summary: generated XBRL, generated iXBRL, package manifest, checksums, file sizes
The script lives at scripts/demo-canonical-v2.mjs.
Recommended Fixtures
sec-basic-footnoteBest for explaining fact preservation plus footnote linkage.sec-dimensional-linkbaseBest for explaining typed dimensions and presentation/calculation/definition relationships.ifrs-basicBest for explaining that the canonical model spans more than one reporting profile.
Talk Track
- “This source filing is being imported into a canonical JSON model.”
- “The canonical model preserves contexts, units, dimensions, footnotes, and relationships.”
- “Validation is profile-aware, even though support is still prerelease.”
- “The same canonical document can generate both XBRL and iXBRL.”
- “The package manifest gives us deterministic artifacts and checksums.”
Support Boundary
Use this wording explicitly:
Current status: prereleaseBest claim: canonical JSON infrastructure for XBRL workflowsNot yet claimed: regulator-ready submission compatibility
The matching public milestone entry is 0.2.0-alpha.1.