Milestone 2: module/model docs (MD, Sphinx RST, PDF) and work log

74 source modules documented with extracted signatures, JSDoc params,
imports, and call graphs. 10 first-class models (PriceRule through
StatusResponse) have their own MD/RST/PDF. Sphinx HTML builds from
docs/sphinx. Per-module PDFs in docs/modules-pdf and docs/models-pdf.

Middleware gates 2–6 and 10 pass on MOCK_VERAE without NATS.

Learned: RST includes are relative to the RST file; keep one PDF per
module; Add Numbers remains the only push required tomorrow.
This commit is contained in:
George Lambert 2026-09-09 02:44:51 -04:00
parent b814501441
commit 10c663cc0c
347 changed files with 17200 additions and 14 deletions

View file

@ -0,0 +1,48 @@
# `verae-zapier-middleware/debug/trace`
**Package:** `verae-zapier-middleware`
**Source:** `packages/verae-zapier-middleware/src/debug/trace.js`
**Lines:** 96
## What this module is
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`withTrace`, `traceMiddleware`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `withTrace` | `options, fn` | options: `object|(() => T|Promise<T>)`, options.traceId: `string`, options.span: `string`, fn: `() => T|Promise<T>` | `T|Promise<T>` — Return value of `fn`. | see Call graph |
| `traceMiddleware` | `req, res, next` | req: `import('express').Request`, res: `import('express').Response`, next: `import('express').NextFunction` | `void` | see Call graph |
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `withTrace` | `{ traceId, span: `${req.method} ${req.path}` }, (` |
## What it imports / requires
- `./logger.js`
- `./trace-context.js`
## Call graph (identifiers invoked)
`createDebugger`, `id`, `span`, `withTrace`, `async`, `getTraceId`, `getStore`, `generateTraceId`, `run`, `debug`, `callback`, `then`, `import`, `traceMiddleware`, `trim`, `setHeader`, `next`
Each identifier is a call site in this file. Follow the import list to see the defining module; open that modules MD for parameter and return types.
## Return values (how to read this)
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
- Pricing functions return integer **cents** on `Quote.totalCents`.