George Lambert
10c663cc0c
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.
41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
# `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 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`.
|
||
|