{"_id":"@codeforamerica/blueprint-explorer","_rev":"3-b30526bfcaf1cbc38ad58d4b912d76e7","name":"@codeforamerica/blueprint-explorer","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@codeforamerica/blueprint-explorer","version":"0.1.0","license":"SEE LICENSE IN LICENSE","_id":"@codeforamerica/blueprint-explorer@0.1.0","maintainers":[{"name":"fritzjooste","email":"fritz@fritzjooste.com"},{"name":"alice-sjconsulting","email":"alice@sjconsulting.us"},{"name":"devowhippit","email":"dhirth@codeforamerica.org"},{"name":"chriscorrea","email":"ccorrea@codeforamerica.org"},{"name":"mryhmln","email":"mhamlin@codeforamerica.org"},{"name":"lkacenjar","email":"lkacenjar@codeforamerica.org"}],"homepage":"https://github.com/codeforamerica/safety-net-blueprint#readme","bugs":{"url":"https://github.com/codeforamerica/safety-net-blueprint/issues"},"dist":{"shasum":"1ae0bc713962bf567af56b91d47b9c8bf7ac3df5","tarball":"https://registry.npmjs.org/@codeforamerica/blueprint-explorer/-/blueprint-explorer-0.1.0.tgz","fileCount":57,"integrity":"sha512-7ElukEUkbquIonC5gwbictc7C1RdrFAKgpgYVf23s6XPspXN0TA1Ho/BbHXiBlwEFEG7gkxET9YIDnf8AJjOLw==","signatures":[{"sig":"MEUCIQDoqcyQeN5khr3J5m4Dy7FFC6OSouLpH+XGjISW+/20NgIgHi4p5A6FlnuUl0M5fHE+/u+uli3fwO/MmUonYs6CTKU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":693675},"type":"module","engines":{"node":">=22.11.0"},"gitHead":"590957218a4729cb34da2783be15dd161a110140","scripts":{"test":"node --test tests/*.test.js tests/**/*.test.js","build":"node build.js","test:unit":"node --test tests/*.test.js tests/**/*.test.js","build:context-map":"node build.js --only=context-map","build:api-reference":"node build.js --only=api-reference","build:event-catalog":"node build.js --only=event-catalog","build:field-inventory":"node src/data-dictionaries/generate-field-inventory.mjs","build:client-reference":"node build.js --only=client-reference","build:data-dictionaries":"node build.js --only=data-dictionaries","build:sequence-diagrams":"node build.js --only=sequence-diagrams","build:state-machine-docs":"node build.js --only=state-machine-docs"},"_npmUser":{"name":"mryhmln","email":"mhamlin@codeforamerica.org"},"repository":{"url":"git+https://github.com/codeforamerica/safety-net-blueprint.git","type":"git","directory":"packages/blueprint-explorer"},"_npmVersion":"10.9.8","description":"Static documentation generator for Blueprint framework projects — contract reference, state machine diagrams, event catalog, and data dictionaries","directories":{},"_nodeVersion":"22.23.2","dependencies":{"ajv":"^8.17.1","js-yaml":"^4.1.0","@codeforamerica/blueprint-core":"^0.1.0","@apidevtools/json-schema-ref-parser":"^11.7.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/blueprint-explorer_0.1.0_1789144544056_0.8654782499831684","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2026-09-11T16:35:43.876Z","modified":"2026-09-16T22:36:18.322Z","0.1.0":"2026-09-11T16:35:44.214Z"},"bugs":{"url":"https://github.com/codeforamerica/safety-net-blueprint/issues"},"license":"SEE LICENSE IN LICENSE","homepage":"https://github.com/codeforamerica/safety-net-blueprint#readme","repository":{"url":"git+https://github.com/codeforamerica/safety-net-blueprint.git","type":"git","directory":"packages/blueprint-explorer"},"description":"Static documentation generator for Blueprint framework projects — contract reference, state machine diagrams, event catalog, and data dictionaries","maintainers":[{"email":"fritz@fritzjooste.com","name":"fritzjooste"},{"email":"dhirth@codeforamerica.org","name":"devowhippit"},{"email":"rob.diciuccio@gmail.com","name":"robdiciuccio"},{"email":"ccorrea@codeforamerica.org","name":"chriscorrea"},{"email":"mhamlin@codeforamerica.org","name":"mryhmln"},{"email":"lkacenjar@codeforamerica.org","name":"lkacenjar"}],"readme":"# @codeforamerica/blueprint-explorer\n\n> Static documentation generator for Blueprint framework projects — contract reference, state machine diagrams, event catalog, and data dictionaries\n\n[![npm version](https://img.shields.io/npm/v/@codeforamerica/blueprint-explorer.svg)](https://www.npmjs.com/package/@codeforamerica/blueprint-explorer)\n[![license](https://img.shields.io/npm/l/@codeforamerica/blueprint-explorer.svg)](https://github.com/codeforamerica/safety-net-blueprint/blob/main/LICENSE)\n\n> **Pre-release:** This package is at `0.x`. Until `1.0.0`, minor versions may include breaking changes. Pin your version if stability matters.\n\n## Installation\n\n```bash\nnpm install --save-dev @codeforamerica/blueprint-explorer\n```\n\n## What It Does\n\nGenerates a set of static HTML reference tools from resolved Blueprint contract artifacts. Point it at your resolved specs and TypeScript clients to produce a browsable documentation hub that can be published as a GitHub Pages site or any static host.\n\n| Tool | Description |\n|------|-------------|\n| **API Reference** | Endpoint docs derived from resolved OpenAPI specs — parameters, request/response schemas, status codes, and links to related state machine transitions |\n| **Client Reference** | TypeScript SDK reference — types, methods, and usage examples per domain |\n| **State Machine Docs** | Full state machine reference — states, transitions, guard conditions, actor restrictions, and event subscriptions per resource |\n| **Event Catalog** | Cross-domain event index — every emitted event with its publisher, payload schema, and known subscribers |\n| **Data Dictionaries** | Field-level reference derived from writable schemas — field names, types, policy citations, and data classifications |\n| **Sequence Diagrams** | Key workflow sequences showing cross-domain interactions |\n| **Context Map** | Domain relationship diagram showing cross-domain data dependencies |\n\n## Usage\n\n```bash\n# Build all tools\nnode build.js \\\n  --content=./packages/safety-net-explorer \\\n  --resolved=./resolved \\\n  --clients=./clients\n\n# Build a single tool\nnode build.js --only=api-reference --resolved=./resolved --clients=./clients\nnode build.js --only=state-machine-docs --resolved=./resolved\nnode build.js --only=event-catalog --resolved=./resolved\nnode build.js --only=data-dictionaries --resolved=./resolved\n```\n\nOutput is written to the `--content` directory as static HTML files. The API reference, state machine docs, event catalog, and data dictionaries update automatically as contracts change — rebuild after each resolve step.\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/codeforamerica/safety-net-blueprint/blob/main/packages/blueprint-explorer/CHANGELOG.md) for release history.\n\n## Documentation\n\nSee the [Safety Net Blueprint documentation](https://github.com/codeforamerica/safety-net-blueprint) for full guides and reference.\n\n## License\n\n[PolyForm Noncommercial License 1.0.0](https://polyformproject.org/licenses/noncommercial/1.0.0/)\n","readmeFilename":"README.md"}