George Lambert
85b5b53ea9
Some checks are pending
offline / test (push) Waiting to run
Module and model book cards now point at generated index.html/index.pdf instead of directory URLs that 404. WeasyPrint file:// annotations are mapped to https://zapier.georgelambert.org/ paths that exist. Developer module, architecture, and research snapshot links target published files.
2.9 KiB
2.9 KiB
Developer Module Index
Each module document lists every exported function, its purpose, inputs, outputs, and side effects.
Implementation status follows TODO.md phases. Docs describe the target contract so implementers and reviewers share one API surface.
Middleware (verae-zapier-middleware/src)
| Module doc | Source path | Phase |
|---|---|---|
| debug.md | debug/ |
1 |
| config.md | config.js |
2 |
| errors.md | errors.js |
2 |
| app.md | app.js, index.js |
2 |
| store/db.md | store/db.js |
3 |
| store/tenants.md | store/tenants.js |
3 |
| store/usage.md | store/usage.js |
3 |
| store/webhooks.md | store/webhooks.js |
3 |
| lib/tokens.md | lib/tokens.js |
4 |
| veraeClient.md | clients/veraeClient.js |
4 |
| authService.md | services/authService.js |
5 |
| entitlementService.md | services/entitlementService.js |
5 |
| authenticate.md | middleware/*.js |
5 |
| timestampService.md | services/timestampService.js |
6 |
| verifyService.md | services/verifyService.js |
6 |
| webhookService.md | services/webhookService.js |
6 |
| routes.md | routes/*.js |
6 |
| nats.md | nats/*.js |
7 |
| workers.md | workers/*.js |
8–9 |
| tenantService.md | services/tenantService.js |
10 |
Full export tables also live in function-reference.md.
Zapier app (verae-zapier)
| Module doc | Source path | Phase |
|---|---|---|
| verae-zapier/index.md | index.js, authentication.js, creates/searches/triggers |
11 |
Documentation rules
When you add or change an export:
- Update JSDoc in the source file (
@param,@returns, purpose sentence). - Update the matching module markdown table.
- Add/adjust unit tests in the phase that owns the module.
- Instrument boundaries with
createDebugger('<namespace>').