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

View file

@ -0,0 +1,36 @@
# `verae-zapier/creates/add_numbers`
**Package:** `verae-zapier`
**Source:** `packages/verae-zapier/creates/add_numbers.js`
**Lines:** 3
## What this module is
Implementation module in `verae-zapier`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
_No named `export` / `module.exports` keys detected._
## Types / interfaces / classes
_None extracted._
## Functions
_No top-level functions extracted._
## What it imports / requires
- `../../verae-activate/creates/add_numbers`
## 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-zapier.creates.add_numbers
================================
Generated API sheet for ``verae-zapier/creates/add_numbers``.
.. include:: add_numbers.md
:literal:

View file

@ -0,0 +1,41 @@
# `verae-zapier/creates/batch_timestamp`
**Package:** `verae-zapier`
**Source:** `packages/verae-zapier/creates/batch_timestamp.js`
**Lines:** 40
## What this module is
Implementation module in `verae-zapier`. 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) |
|------|------------|---------------------|---------|-----------------------------|
| `base` | `(none)` | — | `unknown` | see Call graph |
| `perform` | `z, bundle` | — | `unknown` | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`async`, `split`, `map`, `trim`, `filter`, `request`, `base`, `timestamping`
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.creates.batch_timestamp
====================================
Generated API sheet for ``verae-zapier/creates/batch_timestamp``.
.. include:: batch_timestamp.md
:literal:

View file

@ -0,0 +1,41 @@
# `verae-zapier/creates/create_timestamp`
**Package:** `verae-zapier`
**Source:** `packages/verae-zapier/creates/create_timestamp.js`
**Lines:** 38
## What this module is
Implementation module in `verae-zapier`. 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) |
|------|------------|---------------------|---------|-----------------------------|
| `base` | `(none)` | — | `unknown` | see Call graph |
| `perform` | `z, bundle` | — | `unknown` | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`async`, `request`, `base`
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.creates.create_timestamp
=====================================
Generated API sheet for ``verae-zapier/creates/create_timestamp``.
.. include:: create_timestamp.md
:literal:

View file

@ -0,0 +1,41 @@
# `verae-zapier/creates/timestamp_and_wait`
**Package:** `verae-zapier`
**Source:** `packages/verae-zapier/creates/timestamp_and_wait.js`
**Lines:** 55
## What this module is
Implementation module in `verae-zapier`. 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) |
|------|------------|---------------------|---------|-----------------------------|
| `base` | `(none)` | — | `unknown` | see Call graph |
| `perform` | `z, bundle` | — | `unknown` | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`async`, `request`, `base`
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.creates.timestamp_and_wait
=======================================
Generated API sheet for ``verae-zapier/creates/timestamp_and_wait``.
.. include:: timestamp_and_wait.md
:literal:

View file

@ -0,0 +1,41 @@
# `verae-zapier/creates/verify_timestamp`
**Package:** `verae-zapier`
**Source:** `packages/verae-zapier/creates/verify_timestamp.js`
**Lines:** 37
## What this module is
Implementation module in `verae-zapier`. 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) |
|------|------------|---------------------|---------|-----------------------------|
| `base` | `(none)` | — | `unknown` | see Call graph |
| `perform` | `z, bundle` | — | `unknown` | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`async`, `request`, `base`
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.creates.verify_timestamp
=====================================
Generated API sheet for ``verae-zapier/creates/verify_timestamp``.
.. include:: verify_timestamp.md
:literal:

View file

@ -0,0 +1,48 @@
# `verae-zapier/index`
**Package:** `verae-zapier`
**Source:** `packages/verae-zapier/index.js`
**Lines:** 79
## What this module is
Implementation module in `verae-zapier`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`version`, `platformVersion`, `authentication`, `beforeRequest`, `afterResponse`, `triggers`, `timestampCompleted`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `addApiKey` | `request, _z, bundle` | request: `object`, _z: `object`, bundle: `object` | `unknown` | see Call graph |
| `mapMiddlewareErrors` | `response, z` | response: `object`, z: `object` | `unknown` | see Call graph |
## What it imports / requires
- `./authentication`
- `./creates/timestamp_and_wait`
- `./creates/create_timestamp`
- `./creates/verify_timestamp`
- `./creates/batch_timestamp`
- `./creates/add_numbers`
- `./searches/job_status`
- `./triggers/timestamp_completed`
- `zapier-platform-core`
- `./package.json`
## 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-zapier.index
==================
Generated API sheet for ``verae-zapier/index``.
.. include:: index.md
:literal:

View file

@ -0,0 +1,41 @@
# `verae-zapier/searches/job_status`
**Package:** `verae-zapier`
**Source:** `packages/verae-zapier/searches/job_status.js`
**Lines:** 34
## What this module is
Implementation module in `verae-zapier`. 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) |
|------|------------|---------------------|---------|-----------------------------|
| `base` | `(none)` | — | `unknown` | see Call graph |
| `perform` | `z, bundle` | — | `unknown` | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`async`, `request`, `base`, `encodeURIComponent`
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.searches.job_status
================================
Generated API sheet for ``verae-zapier/searches/job_status``.
.. include:: job_status.md
:literal:

View file

@ -0,0 +1,44 @@
# `verae-zapier/triggers/timestamp_completed`
**Package:** `verae-zapier`
**Source:** `packages/verae-zapier/triggers/timestamp_completed.js`
**Lines:** 54
## What this module is
Implementation module in `verae-zapier`. 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) |
|------|------------|---------------------|---------|-----------------------------|
| `base` | `(none)` | — | `unknown` | see Call graph |
| `subscribeHook` | `z, bundle` | — | `unknown` | see Call graph |
| `unsubscribeHook` | `z, bundle` | — | `unknown` | see Call graph |
| `perform` | `z, bundle` | — | `unknown` | see Call graph |
| `performList` | `(none)` | — | `unknown` | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`async`, `request`, `base`
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.triggers.timestamp_completed
=========================================
Generated API sheet for ``verae-zapier/triggers/timestamp_completed``.
.. include:: timestamp_completed.md
:literal: