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,40 @@
# `verae-activate/authentication`
**Package:** `verae-activate`
**Source:** `packages/verae-activate/authentication.js`
**Lines:** 58
## What this module is
Implementation module in `verae-activate`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`type`, `fields`, `key`, `required`, `false`, `label`, `helpText`, `Later`, `https`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `testAuth` | `z, bundle` | z: `object`, bundle: `object` | `Promise<{ok: boolean, mode: string, label: string` — >} | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`async`, `replace`, `request`
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-activate.authentication
=============================
Generated API sheet for ``verae-activate/authentication``.
.. include:: authentication.md
:literal:

View file

@ -0,0 +1,41 @@
# `verae-activate/creates/add_numbers`
**Package:** `verae-activate`
**Source:** `packages/verae-activate/creates/add_numbers.js`
**Lines:** 95
## What this module is
Implementation module in `verae-activate`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`key`, `noun`, `display`, `label`, `description`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `toFiniteNumber` | `value, name` | value: `unknown`, name: `string` | `number` | see Call graph |
| `perform` | `z, bundle` | z: `object`, bundle: `object`, bundle.inputData: `object`, bundle.inputData.number1: `string|number`, bundle.inputData.number2: `string|number`, bundle.authData: `object` | `Promise<{number1: number, number2: number, sum: number, mode: string` — >} | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`number2`, `toFiniteNumber`, `isFinite`, `async`, `replace`, `request`
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-activate.creates.add_numbers
==================================
Generated API sheet for ``verae-activate/creates/add_numbers``.
.. include:: add_numbers.md
:literal:

View file

@ -0,0 +1,39 @@
# `verae-activate/index`
**Package:** `verae-activate`
**Source:** `packages/verae-activate/index.js`
**Lines:** 21
## What this module is
Implementation module in `verae-activate`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`version`, `platformVersion`, `authentication`, `creates`, `addNumbers`
## Types / interfaces / classes
_None extracted._
## Functions
_No top-level functions extracted._
## What it imports / requires
- `./authentication`
- `./creates/add_numbers`
- `./package.json`
- `zapier-platform-core`
## Call graph (identifiers invoked)
_No local call identifiers extracted._
## 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-activate.index
====================
Generated API sheet for ``verae-activate/index``.
.. include:: index.md
:literal: