George Lambert 10c663cc0c 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.

2026-09-09 02:44:51 -04:00

1.3 KiB

Raw Blame History

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

1.3 KiB Raw Blame History Unescape Escape

verae-activate/authentication