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 KiB

Raw Blame History

`zappier/admin-users`

Package: zappier
Source: packages/zappier/src/admin-users.ts
Lines: 76

What this module is

Implementation module in zappier. The tables below are extracted from the source (signatures + JSDoc).

Exports

AdminUser, AdminUserRepo, newAdminUserId, seedAdminUsersFromEnv, makeAdminUser, InMemoryAdminUserRepo

Types / interfaces / classes

Kind	Name
interface	`AdminUser`
interface	`AdminUserRepo`
class	`InMemoryAdminUserRepo`

Functions

Name	Parameters	Param types (JSDoc)	Returns	Calls (same file / helpers)
`newAdminUserId`	`(none)`	—	`unknown`	see Call graph
`seedAdminUsersFromEnv`	`(none)`	—	`unknown`	see Call graph
	The env-backed seed accounts (preserved from the pre-table behavior).
`makeAdminUser`	`username: string, password: string`	—	`unknown`	see Call graph

Methods (class / object)

Name	Parameters
`list`	`(none)`
`findByUsername`	`username: string`
`save`	`user: AdminUser`
`list`	`(none)`
`findByUsername`	`username: string`
`save`	`user: AdminUser`

What it imports / requires

crypto
./accounts

Call graph (identifiers invoked)

list, findByUsername, save, newAdminUserId, randomBytes, toString, accounts, seedAdminUsersFromEnv, makeAdminUser, hashPassword, now, constructor, map, seeded, find, findIndex, push

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 KiB Raw Blame History Unescape Escape

zappier/admin-users