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.
This commit is contained in:
parent
b814501441
commit
10c663cc0c
347 changed files with 17200 additions and 14 deletions
|
|
@ -0,0 +1,47 @@
|
|||
# `verae-zapier-middleware/services/authService`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/authService.js`
|
||||
**Lines:** 142
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`loginWithCredentials`, `loginWithApiKey`, `resolveAuthContext`, `validateSession`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `loginWithCredentials` | `{ username, password, tenant }` | params: `object`, params.username: `string`, params.password: `string`, params.tenant: `object` | `Promise<{ accessToken: string, expiresAt: string, tenant: object, user: object ` — >} | see Call graph |
|
||||
| `loginWithApiKey` | `apiKey` | apiKey: `string` | `Promise<Awaited<ReturnType<typeof loginWithCredentials>>>` | see Call graph |
|
||||
| `resolveAuthContext` | `rawToken` | rawToken: `string|null` | `Promise<{ tenantId: string, tenant: object, veraeToken: string, authMethod: string ` — >} | see Call graph |
|
||||
| `validateSession` | `rawToken` | rawToken: `string` | `Promise<object>` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../clients/veraeClient.js`
|
||||
- `../store/tenants.js`
|
||||
- `../lib/tokens.js`
|
||||
- `../errors.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `loginWithCredentials`, `debug`, `login`, `issueSessionToken`, `loginWithApiKey`, `getTenantByApiKey`, `resolveAuthContext`, `isApiKey`, `parseSessionToken`, `getTenant`, `parse`, `now`, `validateSession`, `validate`
|
||||
|
||||
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`.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue