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,50 @@
# `verae-zapier-middleware/routes/authRoutes`
**Package:** `verae-zapier-middleware`
**Source:** `packages/verae-zapier-middleware/src/routes/authRoutes.js`
**Lines:** 58
## What this module is
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`authRoutes`
## Types / interfaces / classes
_None extracted._
## Functions
_No top-level functions extracted._
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `asyncHandler` | `async (req, res` |
| `asyncHandler` | `async (req, res` |
## What it imports / requires
- `express`
- `../errors.js`
- `../services/authService.js`
- `../store/usage.js`
- `../store/tenants.js`
- `../lib/tokens.js`
## Call graph (identifiers invoked)
`post`, `asyncHandler`, `async`, `loginWithApiKey`, `json`, `loginWithCredentials`, `get`, `extractBearerToken`, `validateSession`, `getTenant`, `getUsageSummary`
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`.

View file

@ -0,0 +1,7 @@
verae-zapier-middleware.routes.authRoutes
=========================================
Generated API sheet for ``verae-zapier-middleware/routes/authRoutes``.
.. include:: authRoutes.md
:literal:

View file

@ -0,0 +1,46 @@
# `verae-zapier-middleware/routes/index`
**Package:** `verae-zapier-middleware`
**Source:** `packages/verae-zapier-middleware/src/routes/index.js`
**Lines:** 34
## What this module is
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`apiRoutes`
## Types / interfaces / classes
_None extracted._
## Functions
_No top-level functions extracted._
## What it imports / requires
- `express`
- `./authRoutes.js`
- `./timestampRoutes.js`
- `./verifyRoutes.js`
- `./statusRoutes.js`
- `./webhookRoutes.js`
- `./tenantRoutes.js`
- `../middleware/authenticate.js`
- `../middleware/rateLimit.js`
## Call graph (identifiers invoked)
`use`
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`.

View file

@ -0,0 +1,7 @@
verae-zapier-middleware.routes.index
====================================
Generated API sheet for ``verae-zapier-middleware/routes/index``.
.. include:: index.md
:literal:

View file

@ -0,0 +1,48 @@
# `verae-zapier-middleware/routes/statusRoutes`
**Package:** `verae-zapier-middleware`
**Source:** `packages/verae-zapier-middleware/src/routes/statusRoutes.js`
**Lines:** 47
## What this module is
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`statusRoutes`
## Types / interfaces / classes
_None extracted._
## Functions
_No top-level functions extracted._
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `asyncHandler` | `async (req, res` |
| `asyncHandler` | `async (req, res` |
| `asyncHandler` | `async (req, res` |
## What it imports / requires
- `express`
- `../errors.js`
- `../services/timestampService.js`
## Call graph (identifiers invoked)
`post`, `asyncHandler`, `async`, `isArray`, `getBatchJobStatus`, `json`, `get`, `getJobVerification`, `getJobStatus`
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`.

View file

@ -0,0 +1,7 @@
verae-zapier-middleware.routes.statusRoutes
===========================================
Generated API sheet for ``verae-zapier-middleware/routes/statusRoutes``.
.. include:: statusRoutes.md
:literal:

View file

@ -0,0 +1,50 @@
# `verae-zapier-middleware/routes/tenantRoutes`
**Package:** `verae-zapier-middleware`
**Source:** `packages/verae-zapier-middleware/src/routes/tenantRoutes.js`
**Lines:** 47
## What this module is
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`publicTenantRoutes`, `adminTenantRoutes`
## Types / interfaces / classes
_None extracted._
## Functions
_No top-level functions extracted._
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `asyncHandler` | `async (req, res` |
| `next` | `(none)` |
| `asyncHandler` | `async (req, res` |
| `asyncHandler` | `async (_req, res` |
## What it imports / requires
- `express`
- `../errors.js`
- `../services/tenantService.js`
- `../config.js`
## Call graph (identifiers invoked)
`post`, `asyncHandler`, `async`, `selfServeSignup`, `status`, `json`, `use`, `next`, `provisionTenant`, `get`, `listProvisionedTenants`
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`.

View file

@ -0,0 +1,7 @@
verae-zapier-middleware.routes.tenantRoutes
===========================================
Generated API sheet for ``verae-zapier-middleware/routes/tenantRoutes``.
.. include:: tenantRoutes.md
:literal:

View file

@ -0,0 +1,48 @@
# `verae-zapier-middleware/routes/timestampRoutes`
**Package:** `verae-zapier-middleware`
**Source:** `packages/verae-zapier-middleware/src/routes/timestampRoutes.js`
**Lines:** 50
## What this module is
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`timestampRoutes`
## Types / interfaces / classes
_None extracted._
## Functions
_No top-level functions extracted._
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `asyncHandler` | `async (req, res` |
| `asyncHandler` | `async (req, res` |
| `asyncHandler` | `async (req, res` |
## What it imports / requires
- `express`
- `../errors.js`
- `../services/timestampService.js`
## Call graph (identifiers invoked)
`post`, `asyncHandler`, `async`, `createTimestamp`, `status`, `json`, `createTimestampAndWait`, `isArray`, `createBatchTimestamp`
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`.

View file

@ -0,0 +1,7 @@
verae-zapier-middleware.routes.timestampRoutes
==============================================
Generated API sheet for ``verae-zapier-middleware/routes/timestampRoutes``.
.. include:: timestampRoutes.md
:literal:

View file

@ -0,0 +1,47 @@
# `verae-zapier-middleware/routes/verifyRoutes`
**Package:** `verae-zapier-middleware`
**Source:** `packages/verae-zapier-middleware/src/routes/verifyRoutes.js`
**Lines:** 37
## What this module is
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`verifyRoutes`
## Types / interfaces / classes
_None extracted._
## Functions
_No top-level functions extracted._
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `asyncHandler` | `async (req, res` |
| `asyncHandler` | `async (req, res` |
## What it imports / requires
- `express`
- `../errors.js`
- `../services/verifyService.js`
## Call graph (identifiers invoked)
`post`, `asyncHandler`, `async`, `verifyTimestamp`, `json`, `isArray`, `verifyBatch`
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`.

View file

@ -0,0 +1,7 @@
verae-zapier-middleware.routes.verifyRoutes
===========================================
Generated API sheet for ``verae-zapier-middleware/routes/verifyRoutes``.
.. include:: verifyRoutes.md
:literal:

View file

@ -0,0 +1,49 @@
# `verae-zapier-middleware/routes/webhookRoutes`
**Package:** `verae-zapier-middleware`
**Source:** `packages/verae-zapier-middleware/src/routes/webhookRoutes.js`
**Lines:** 45
## What this module is
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`webhookRoutes`
## Types / interfaces / classes
_None extracted._
## Functions
_No top-level functions extracted._
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `asyncHandler` | `async (req, res` |
| `asyncHandler` | `async (req, res` |
| `asyncHandler` | `async (req, res` |
## What it imports / requires
- `express`
- `../errors.js`
- `../services/webhookService.js`
- `../store/webhooks.js`
## Call graph (identifiers invoked)
`post`, `asyncHandler`, `async`, `subscribe`, `status`, `json`, `delete`, `unsubscribe`, `get`, `listWebhooksForTenant`
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`.

View file

@ -0,0 +1,7 @@
verae-zapier-middleware.routes.webhookRoutes
============================================
Generated API sheet for ``verae-zapier-middleware/routes/webhookRoutes``.
.. include:: webhookRoutes.md
:literal: