API reference
Codevibe Sign is split into small packages with one job each. Use the whole service, or only the parts you need.
| Package | What it does | Status |
|---|---|---|
@codevibe_technology/sign-core | Domain rules: envelopes, routing, reminders, expiry, the audit chain, tokens, OTPs. | Ready to try |
@codevibe_technology/sign-pdf | Draws field values, appends the certificate page, seals and verifies PDFs. | Ready to try |
@codevibe_technology/sign-server | HTTP API and runtime, with adapters for storage, files, mail and OTP. | Ready to try |
@codevibe_technology/sign-react | Signature pad, signing view and field placement components. | Ready to try |
@codevibe_technology/sign-aadhaar | Aadhaar eSign through a licensed eSign provider, with your own account. | Ready to try |
For the HTTP API itself, with every route, schema and error code, see the HTTP API reference, which you can try against your own server.
All packages are pre-release (0.0.0) and their APIs may change before 0.1.
Conventions
- TypeScript, strict, ESM first, with CommonJS builds and type declarations. Node 20 or later.
- Each package's public API is exported only from its entry point.
- Errors are
SignErrorinstances with a stablecode, never bare strings. See the error codes.
Dependencies
| Package | Depends on |
|---|---|
sign-core | nothing at runtime |
sign-pdf | pdf-lib, @signpdf/*, node-forge |
sign-server | core, pdf, hono, nodemailer, postgres |
sign-react | core; react, react-dom and pdfjs-dist as peers |
sign-aadhaar | core |