Skip to content

Repository files navigation

Typed Standards

The home of Typed Standards — the standard for verifiable, signed evidence packages, its reference verification core, and the typedstandards.org site.

Where the specification text lives: the Typed Standards Specification is maintained in the hub repo at civic-ai-tools/docs/architecture/typed-standards-specification.md (v0.1 Working Draft, CC BY 4.0). This repo holds the reference implementations of it and the site that serves it.

This is an npm-workspaces monorepo.

Repo status (as of the current main). This monorepo now contains both published packages — @typedstandards/verify-core and @typedstandards/produce-coreand the typedstandards.org site at apps/web, which serves the client-side /verify verifier, /roadmap, and the host directory at /.well-known/typed-host-directory.json. The "later phase" note below predates that and is retained pending a fuller README revision.

Packages

Package Description
packages/verify-core @typedstandards/verify-core — the portable, browser-safe §9.2 verification core. Published to npm so every consumer (civicaitools.org server, typedstandards.org browser client) depends on one versioned source that cannot drift.
packages/produce-core @typedstandards/produce-core — the I/O-free producer core: envelope and attestation assembly (§8.1, §8.12), Ed25519ph signing (§8.3.1), RFC 3161 / Rekor proof codecs, and the §8.8.1 commitment view. Shares one canonicalization implementation with verify-core, so producer and verifier compute the same envelope hash by construction.

Apps (the typedstandards.org Next.js site and its /verify client-side verifier) land in a later phase under apps/.

Develop

npm install            # installs all workspaces
npm run build          # build every workspace that defines a build
npm test               # run every workspace's tests

Per-package:

npm run build --workspace @typedstandards/verify-core
npm run test  --workspace @typedstandards/verify-core

Publishing @typedstandards/verify-core

The package publishes to the public npm registry under the @typedstandards scope. Requires the typedstandards npm org and npm login:

npm run build --workspace @typedstandards/verify-core
npm publish   --workspace @typedstandards/verify-core   # publishConfig.access = public

Contact routing

Every contact / express-interest entry point on typedstandards.org (landing page and footer) reads one constant: EXPRESS_INTEREST_URL in apps/web/src/lib/site-config.ts. When a project inbox exists, changing that one constant re-routes every entry point — no other edit needed.

Contributing

See CONTRIBUTING.md — getting started, the branch-and-PR rule (main auto-deploys to production, so no direct pushes), and the DCO sign-off requirement. This repo is one of four in the Civic AI Tools / Typed Standards project; the hub CONTRIBUTING guide maps all four and where to file what.

License

MIT © Nathan Storey

About

Typed Standards — neutral evidence verifier + spec home (typedstandards.org)

Resources

Code of conduct

Contributing

Stars

4 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages