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.

docs/sphinx/modules/verae-activate/authentication.md

@@ -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 module’s 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`.
+

docs/sphinx/modules/verae-activate/authentication.rst

@@ -0,0 +1,7 @@
+verae-activate.authentication
+=============================
+
+Generated API sheet for ``verae-activate/authentication``.
+
+.. include:: authentication.md
+   :literal:

docs/sphinx/modules/verae-activate/creates/add_numbers.md

@@ -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 module’s 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`.
+

docs/sphinx/modules/verae-activate/creates/add_numbers.rst

@@ -0,0 +1,7 @@
+verae-activate.creates.add_numbers
+==================================
+
+Generated API sheet for ``verae-activate/creates/add_numbers``.
+
+.. include:: add_numbers.md
+   :literal:

docs/sphinx/modules/verae-activate/index.md

@@ -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`.
+

docs/sphinx/modules/verae-activate/index.rst

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

docs/sphinx/modules/verae-zapier-middleware/app.md

@@ -0,0 +1,45 @@
+# `verae-zapier-middleware/app`
+
+**Package:** `verae-zapier-middleware`  
+**Source:** `packages/verae-zapier-middleware/src/app.js`  
+**Lines:** 51
+
+## What this module is
+
+Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
+
+## Exports
+
+`createApp`
+
+## Types / interfaces / classes
+
+_None extracted._
+
+## Functions
+
+| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
+|------|------------|---------------------|---------|-----------------------------|
+| `createApp` | `options = {}` | — | `import('express').Express` | see Call graph |
+
+## What it imports / requires
+
+- `express`
+- `./errors.js`
+- `./debug/logger.js`
+- `./debug/trace.js`
+- `./routes/index.js`
+- `./store/db.js`
+
+## Call graph (identifiers invoked)
+
+`createDebugger`, `app`, `import`, `createApp`, `loadStore`, `express`, `disable`, `use`, `json`, `get`, `sendError`, `info`
+
+Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.
+

docs/sphinx/modules/verae-zapier-middleware/app.rst

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

docs/sphinx/modules/verae-zapier-middleware/clients/veraeClient.md

@@ -0,0 +1,66 @@
+# `verae-zapier-middleware/clients/veraeClient`
+
+**Package:** `verae-zapier-middleware`  
+**Source:** `packages/verae-zapier-middleware/src/clients/veraeClient.js`  
+**Lines:** 288
+
+## What this module is
+
+Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
+
+## Exports
+
+`veraeClient`, `clearMockJobs`
+
+## Types / interfaces / classes
+
+_None extracted._
+
+## Functions
+
+| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
+|------|------------|---------------------|---------|-----------------------------|
+| `delay` | `ms` | ms: `number` | `Promise<void>` | see Call graph |
+| `mockLogin` | `{ username, password }` | ms: `number` | `Promise<void>` | see Call graph |
+| `mockValidate` | `token` | — | `unknown` | see Call graph |
+| `mockCreateTimestamp` | `{ data, hashAlg }` | — | `unknown` | see Call graph |
+| `mockGetStatus` | `jobId` | — | `unknown` | see Call graph |
+| `mockVerify` | `{ certificate }` | — | `unknown` | see Call graph |
+| `request` | `path, { method = 'GET', token, body } = {}` | path: `string` | `Promise<any>` | see Call graph |
+| `clearMockJobs` | `(none)` | — | `void` | see Call graph |
+
+## Methods (class / object)
+
+| Name | Parameters |
+|------|------------|
+| `setTimeout` | `(` |
+| `login` | `credentials` |
+| `validate` | `token` |
+| `createTimestamp` | `token, body` |
+| `createBatchTimestamp` | `token, body` |
+| `getStatus` | `token, jobId` |
+| `getBatchStatus` | `token, body` |
+| `verify` | `token, body` |
+| `verifyBatch` | `token, body` |
+| `getJobVerification` | `token, jobId` |
+| `waitForJob` | `token, jobId, { maxAttempts, intervalMs }` |
+
+## What it imports / requires
+
+- `node:crypto`
+- `../config.js`
+- `../errors.js`
+- `../debug/logger.js`
+
+## Call graph (identifiers invoked)
+
+`net`, `createDebugger`, `delay`, `setTimeout`, `mockLogin`, `now`, `toISOString`, `randomUUID`, `includes`, `mockValidate`, `startsWith`, `replace`, `mockCreateTimestamp`, `set`, `get`, `mockGetStatus`, `mockVerify`, `request`, `debug`, `fetch`, `stringify`, `text`, `parse`, `error`, `client`, `login`, `validate`, `createTimestamp`, `createBatchTimestamp`, `push`, `getStatus`, `encodeURIComponent`, `getBatchStatus`, `verify`, `verifyBatch`, `getJobVerification`, `waitForJob`, `jobs`, `clearMockJobs`, `clear`
+
+Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.
+

docs/sphinx/modules/verae-zapier-middleware/clients/veraeClient.rst

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

docs/sphinx/modules/verae-zapier-middleware/config.md

@@ -0,0 +1,45 @@
+# `verae-zapier-middleware/config`
+
+**Package:** `verae-zapier-middleware`  
+**Source:** `packages/verae-zapier-middleware/src/config.js`  
+**Lines:** 143
+
+## What this module is
+
+Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
+
+## Exports
+
+`loadEnvFile`, `config`, `PLAN_LIMITS`
+
+## Types / interfaces / classes
+
+_None extracted._
+
+## Functions
+
+| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
+|------|------------|---------------------|---------|-----------------------------|
+| `loadEnvFile` | `(none)` | — | `void` | see Call graph |
+| `bool` | `value, fallback = false` | value: `string|undefined`, fallback: `boolean` | `boolean` | see Call graph |
+| `int` | `value, fallback` | value: `string|undefined`, fallback: `number` | `number` | see Call graph |
+
+## What it imports / requires
+
+- `node:fs`
+- `node:path`
+- `node:url`
+- `./debug/logger.js`
+
+## Call graph (identifiers invoked)
+
+`createDebugger`, `dirname`, `fileURLToPath`, `resolve`, `loadEnvFile`, `existsSync`, `readFileSync`, `split`, `trim`, `startsWith`, `indexOf`, `slice`, `bool`, `includes`, `toLowerCase`, `int`, `parseInt`, `isFinite`, `replace`, `info`
+
+Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.
+

docs/sphinx/modules/verae-zapier-middleware/config.rst

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

docs/sphinx/modules/verae-zapier-middleware/debug/config.md

@@ -0,0 +1,43 @@
+# `verae-zapier-middleware/debug/config`
+
+**Package:** `verae-zapier-middleware`  
+**Source:** `packages/verae-zapier-middleware/src/debug/config.js`  
+**Lines:** 107
+
+## What this module is
+
+Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
+
+## Exports
+
+`parseDebugVeraeEnv`, `parseLevel`, `loadDebugConfig`, `shouldLog`
+
+## Types / interfaces / classes
+
+_None extracted._
+
+## Functions
+
+| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
+|------|------------|---------------------|---------|-----------------------------|
+| `parseDebugVeraeEnv` | `raw` | raw: `string|undefined` | `{ enabled: boolean, namespaces: Set<string>|null ` — } | see Call graph |
+| `parseLevel` | `raw, fallback = 'debug'` | raw: `string|undefined`, fallback: `'debug'|'info'|'warn'|'error'` | `'debug'|'info'|'warn'|'error'` | see Call graph |
+| `loadDebugConfig` | `env = process.env` | env: `NodeJS.ProcessEnv` | `DebugConfig` | see Call graph |
+| `shouldLog` | `config, namespace, messageLevel` | config: `DebugConfig`, namespace: `string`, messageLevel: `'debug'|'info'|'warn'|'error'` | `boolean` | see Call graph |
+
+## What it imports / requires
+
+_No imports detected._
+
+## Call graph (identifiers invoked)
+
+`value`, `parseDebugVeraeEnv`, `trim`, `toLowerCase`, `split`, `map`, `filter`, `parseLevel`, `namespaces`, `loadDebugConfig`, `namespace`, `shouldLog`, `has`
+
+Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.
+

docs/sphinx/modules/verae-zapier-middleware/debug/config.rst

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

docs/sphinx/modules/verae-zapier-middleware/debug/index.md

@@ -0,0 +1,39 @@
+# `verae-zapier-middleware/debug/index`
+
+**Package:** `verae-zapier-middleware`  
+**Source:** `packages/verae-zapier-middleware/src/debug/index.js`  
+**Lines:** 25
+
+## What this module is
+
+Implementation module in `verae-zapier-middleware`. 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
+
+- `./config.js`
+- `./logger.js`
+- `./redact.js`
+- `./trace.js`
+
+## 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`.
+

docs/sphinx/modules/verae-zapier-middleware/debug/index.rst

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

docs/sphinx/modules/verae-zapier-middleware/debug/logger.md

@@ -0,0 +1,47 @@
+# `verae-zapier-middleware/debug/logger`
+
+**Package:** `verae-zapier-middleware`  
+**Source:** `packages/verae-zapier-middleware/src/debug/logger.js`  
+**Lines:** 122
+
+## What this module is
+
+Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
+
+## Exports
+
+`setDebugTestSink`, `formatLogLine`, `createDebugger`
+
+## Types / interfaces / classes
+
+_None extracted._
+
+## Functions
+
+| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
+|------|------------|---------------------|---------|-----------------------------|
+| `setDebugTestSink` | `sink` | sink: `null|((line: string) => void)` | `void` | see Call graph |
+| `formatLogLine` | `{ level, namespace, message, meta, traceId }` | parts: `object`, parts.level: `string`, parts.namespace: `string`, parts.message: `string`, parts.meta: `Record<string, unknown>|undefined`, parts.traceId: `string|null` | `string` | see Call graph |
+| `emit` | `line, filePath` | line: `string`, filePath: `string|null` | `void` | see Call graph |
+| `createDebugger` | `namespace` | namespace: `string` | `Debugger` — Logger with debug/info/warn/error methods. | see Call graph |
+| `write` | `level, message, meta` | level: `'debug'|'info'|'warn'|'error'`, message: `string`, meta: `Record<string, unknown>` | `unknown` | see Call graph |
+
+## What it imports / requires
+
+- `node:fs`
+- `./config.js`
+- `./redact.js`
+- `./trace-context.js`
+
+## Call graph (identifiers invoked)
+
+`setDebugTestSink`, `formatLogLine`, `toISOString`, `keys`, `stringify`, `redact`, `toUpperCase`, `emit`, `testSink`, `error`, `appendFileSync`, `createDebugger`, `debug`, `toLowerCase`, `write`, `loadDebugConfig`, `shouldLog`, `getTraceId`
+
+Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.
+

docs/sphinx/modules/verae-zapier-middleware/debug/logger.rst

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

docs/sphinx/modules/verae-zapier-middleware/debug/redact.md

@@ -0,0 +1,41 @@
+# `verae-zapier-middleware/debug/redact`
+
+**Package:** `verae-zapier-middleware`  
+**Source:** `packages/verae-zapier-middleware/src/debug/redact.js`  
+**Lines:** 94
+
+## What this module is
+
+Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
+
+## Exports
+
+`redactString`, `redact`
+
+## Types / interfaces / classes
+
+_None extracted._
+
+## Functions
+
+| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
+|------|------------|---------------------|---------|-----------------------------|
+| `redactString` | `value` | value: `string` | `string` — Original or `[REDACTED]`. | see Call graph |
+| `redact` | `input, depth = 0` | input: `unknown`, depth: `number` | `unknown` — Redacted structure safe for logging. | see Call graph |
+
+## What it imports / requires
+
+_No imports detected._
+
+## Call graph (identifiers invoked)
+
+`redactString`, `test`, `redact`, `isArray`, `map`, `entries`, `has`, `toLowerCase`
+
+Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.
+

docs/sphinx/modules/verae-zapier-middleware/debug/redact.rst

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