Contributing
Contributions are welcome. Read CONTRIBUTING.md for the process (versioning, releases, Git workflow) and AGENTS.md for the technical standards (TypeScript, architecture, error handling, testing, security): both are mandatory for any contribution.
Development workflow
Requires Node.js 22 and pnpm (the version is pinned by packageManager).
git clone https://github.com/circle-rd/auth-ai-ts.git auth-ai
cd auth-ai
pnpm install
pnpm typecheck && pnpm lint && pnpm format:check
pnpm test:coverage
pnpm build
The unit tests run against an in-memory mock identity provider: no auth-service instance is needed. pnpm test:watch runs them while you develop.
Quality gates
The CI workflow runs pnpm typecheck, pnpm lint, pnpm format:check, pnpm test:coverage (with a 80% line coverage threshold) and pnpm build, plus an audit of production dependencies with pnpm audit --prod --audit-level moderate. A pull request must pass all of them.
End-to-end check
When a change touches sign-in, tokens, the wallet or the gateway, run the example app against a real auth-service and use its Self-test. Rebuild the example with pnpm example:build after changing the public API.
Documentation
This site lives in docs-site/ (Nuxt 4 and Docus). Build it in Docker, without installing anything on your machine:
docker build -t auth-ai-ts-docs ./docs-site
docker run --rm -p 3000:3000 auth-ai-ts-docs
Then open http://localhost:3000/auth-ai/typescript/. Every statement in the documentation must be traceable to the source in src/: update the pages in the same pull request as the code. The workflow .github/workflows/docs.yml builds and pushes the image on every push to main.
Reporting a vulnerability
Do not open a public issue: use the private advisory form described in SECURITY.md.