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.
66 lines
2.7 KiB
Markdown
66 lines
2.7 KiB
Markdown
# `verae-zapier-middleware/clients/veraeClient`
|
||
|
||
**Package:** `verae-zapier-middleware`
|
||
**Source:** `packages/verae-zapier-middleware/src/clients/veraeClient.js`
|
||
**Lines:** 288
|
||
|
||
## What this module is
|
||
|
||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||
|
||
## Exports
|
||
|
||
`veraeClient`, `clearMockJobs`
|
||
|
||
## Types / interfaces / classes
|
||
|
||
_None extracted._
|
||
|
||
## Functions
|
||
|
||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||
|------|------------|---------------------|---------|-----------------------------|
|
||
| `delay` | `ms` | ms: `number` | `Promise<void>` | see Call graph |
|
||
| `mockLogin` | `{ username, password }` | ms: `number` | `Promise<void>` | see Call graph |
|
||
| `mockValidate` | `token` | — | `unknown` | see Call graph |
|
||
| `mockCreateTimestamp` | `{ data, hashAlg }` | — | `unknown` | see Call graph |
|
||
| `mockGetStatus` | `jobId` | — | `unknown` | see Call graph |
|
||
| `mockVerify` | `{ certificate }` | — | `unknown` | see Call graph |
|
||
| `request` | `path, { method = 'GET', token, body } = {}` | path: `string` | `Promise<any>` | see Call graph |
|
||
| `clearMockJobs` | `(none)` | — | `void` | see Call graph |
|
||
|
||
## Methods (class / object)
|
||
|
||
| Name | Parameters |
|
||
|------|------------|
|
||
| `setTimeout` | `(` |
|
||
| `login` | `credentials` |
|
||
| `validate` | `token` |
|
||
| `createTimestamp` | `token, body` |
|
||
| `createBatchTimestamp` | `token, body` |
|
||
| `getStatus` | `token, jobId` |
|
||
| `getBatchStatus` | `token, body` |
|
||
| `verify` | `token, body` |
|
||
| `verifyBatch` | `token, body` |
|
||
| `getJobVerification` | `token, jobId` |
|
||
| `waitForJob` | `token, jobId, { maxAttempts, intervalMs }` |
|
||
|
||
## What it imports / requires
|
||
|
||
- `node:crypto`
|
||
- `../config.js`
|
||
- `../errors.js`
|
||
- `../debug/logger.js`
|
||
|
||
## Call graph (identifiers invoked)
|
||
|
||
`net`, `createDebugger`, `delay`, `setTimeout`, `mockLogin`, `now`, `toISOString`, `randomUUID`, `includes`, `mockValidate`, `startsWith`, `replace`, `mockCreateTimestamp`, `set`, `get`, `mockGetStatus`, `mockVerify`, `request`, `debug`, `fetch`, `stringify`, `text`, `parse`, `error`, `client`, `login`, `validate`, `createTimestamp`, `createBatchTimestamp`, `push`, `getStatus`, `encodeURIComponent`, `getBatchStatus`, `verify`, `verifyBatch`, `getJobVerification`, `waitForJob`, `jobs`, `clearMockJobs`, `clear`
|
||
|
||
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`.
|
||
|