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,57 @@
|
|||
# `verae-zapier-middleware/workers/inProcessJobPoller`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/workers/inProcessJobPoller.js`
|
||||
**Lines:** 109
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startInProcessJobPoller`, `stopInProcessJobPoller`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `processJob` | `job` | job: `import('../store/jobWatchers.js').JobWatcher` | `unknown` | see Call graph |
|
||||
| `tick` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `startInProcessJobPoller` | `(none)` | — | `void` | see Call graph |
|
||||
| `stopInProcessJobPoller` | `(none)` | — | `void` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `updateJobWatcher` | `job.id, { attempts }` |
|
||||
| `updateJobWatcher` | `job.id, { status: status.status }` |
|
||||
| `removeJobWatcher` | `job.id` |
|
||||
| `clearInterval` | `timer` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../config.js`
|
||||
- `../clients/veraeClient.js`
|
||||
- `../store/jobWatchers.js`
|
||||
- `../store/webhooks.js`
|
||||
- `../services/webhookService.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `import`, `processJob`, `updateJobWatcher`, `removeJobWatcher`, `warn`, `getStatus`, `debug`, `getActiveWebhooks`, `deliverWebhook`, `error`, `tick`, `listPendingJobs`, `all`, `map`, `poller`, `startInProcessJobPoller`, `info`, `skipped`, `setInterval`, `stopInProcessJobPoller`, `clearInterval`
|
||||
|
||||
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`.
|
||||
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
# `verae-zapier-middleware/workers/jobPollerWorker`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/workers/jobPollerWorker.js`
|
||||
**Lines:** 159
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startJobPollerWorker`, `stopJobPollerWorker`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `resolveVeraeToken` | `msg` | msg: `object` | `Promise<string>` | see Call graph |
|
||||
| `handleWatch` | `data, ctrl` | data: `object` | `unknown` | see Call graph |
|
||||
| `startJobPollerWorker` | `(none)` | — | `Promise<{ stop: () => Promise<void> ` — >} | see Call graph |
|
||||
| `stopJobPollerWorker` | `(none)` | — | `Promise<void>` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../debug/logger.js`
|
||||
- `../config.js`
|
||||
- `../nats/subjects.js`
|
||||
- `../nats/connection.js`
|
||||
- `../nats/publishers.js`
|
||||
- `../clients/veraeClient.js`
|
||||
- `../store/tenants.js`
|
||||
- `../debug/trace.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `polling`, `resolveVeraeToken`, `getTenant`, `login`, `handleWatch`, `withTrace`, `async`, `publishJobEvent`, `ack`, `getStatus`, `debug`, `nak`, `startJobPollerWorker`, `stopJobPollerWorker`, `connectNats`, `ensureStreams`, `consumer`, `add`, `get`, `info`, `consume`, `parse`, `string`, `error`, `abort`
|
||||
|
||||
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`.
|
||||
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
# `verae-zapier-middleware/workers/webhookWorker`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/workers/webhookWorker.js`
|
||||
**Lines:** 139
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startWebhookWorker`, `stopWebhookWorker`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `handleDeliver` | `data, ctrl` | data: `object` | `unknown` | see Call graph |
|
||||
| `startWebhookWorker` | `(none)` | — | `Promise<{ stop: () => Promise<void> ` — >} | see Call graph |
|
||||
| `stopWebhookWorker` | `(none)` | — | `Promise<void>` | see Call graph |
|
||||
| `runConsumer` | `stream, durable` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `runConsumer` | `STREAMS.ZAPIER_EVENTS, CONSUMERS.EVENT_WEBHOOK_ROUTER` |
|
||||
| `runConsumer` | `STREAMS.ZAPIER_WEBHOOKS, CONSUMERS.WEBHOOK_DELIVER` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../debug/logger.js`
|
||||
- `../nats/subjects.js`
|
||||
- `../nats/connection.js`
|
||||
- `../services/webhookService.js`
|
||||
- `../store/webhooks.js`
|
||||
- `../debug/trace.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `messages`, `handleDeliver`, `withTrace`, `async`, `getActiveWebhooks`, `deliverWebhook`, `ack`, `warn`, `keys`, `debug`, `nak`, `worker`, `startWebhookWorker`, `stopWebhookWorker`, `connectNats`, `ensureStreams`, `add`, `info`, `get`, `consume`, `parse`, `string`, `error`, `runConsumer`, `abort`
|
||||
|
||||
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