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

2.1 KiB

Raw Permalink Blame History

`verae-zapier-middleware/lib/tokens`

Package: verae-zapier-middleware
Source: packages/verae-zapier-middleware/src/lib/tokens.js
Lines: 98

What this module is

Implementation module in verae-zapier-middleware. The tables below are extracted from the source (signatures + JSDoc).

Exports

issueSessionToken, parseSessionToken, generateApiKey, isApiKey, extractBearerToken

Types / interfaces / classes

None extracted.

Functions

Name	Parameters	Param types (JSDoc)	Returns	Calls (same file / helpers)
`sign`	`payload`	payload: `string`	`string`	see Call graph
`issueSessionToken`	`{ tenantId, veraeToken, expiresAt }`	params: `object`, params.tenantId: `string`, params.veraeToken: `string`, params.expiresAt: `string`	`string` — Token string starting with `zmt_`	see Call graph
`parseSessionToken`	`token`	token: `string`	`{ tenantId: string, veraeToken: string, expiresAt?: string, nonce?: string` —	null}
`generateApiKey`	`(none)`	—	`string`	see Call graph
`isApiKey`	`value`	value: `unknown`	`boolean`	see Call graph
`extractBearerToken`	`header`	header: `string	undefined`	`string

What it imports / requires

node:crypto
../config.js

Call graph (identifiers invoked)

sign, createHmac, update, digest, issueSessionToken, from, stringify, randomBytes, toString, parseSessionToken, startsWith, slice, lastIndexOf, timingSafeEqual, parse, key, generateApiKey, isApiKey, extractBearerToken, match

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.

2.1 KiB Raw Permalink Blame History Unescape Escape

verae-zapier-middleware/lib/tokens