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
43
docs/modules/verae-zapier-middleware/debug/config.md
Normal file
43
docs/modules/verae-zapier-middleware/debug/config.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# `verae-zapier-middleware/debug/config`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/config.js`
|
||||
**Lines:** 107
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`parseDebugVeraeEnv`, `parseLevel`, `loadDebugConfig`, `shouldLog`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `parseDebugVeraeEnv` | `raw` | raw: `string|undefined` | `{ enabled: boolean, namespaces: Set<string>|null ` — } | see Call graph |
|
||||
| `parseLevel` | `raw, fallback = 'debug'` | raw: `string|undefined`, fallback: `'debug'|'info'|'warn'|'error'` | `'debug'|'info'|'warn'|'error'` | see Call graph |
|
||||
| `loadDebugConfig` | `env = process.env` | env: `NodeJS.ProcessEnv` | `DebugConfig` | see Call graph |
|
||||
| `shouldLog` | `config, namespace, messageLevel` | config: `DebugConfig`, namespace: `string`, messageLevel: `'debug'|'info'|'warn'|'error'` | `boolean` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`value`, `parseDebugVeraeEnv`, `trim`, `toLowerCase`, `split`, `map`, `filter`, `parseLevel`, `namespaces`, `loadDebugConfig`, `namespace`, `shouldLog`, `has`
|
||||
|
||||
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`.
|
||||
|
||||
39
docs/modules/verae-zapier-middleware/debug/index.md
Normal file
39
docs/modules/verae-zapier-middleware/debug/index.md
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
# `verae-zapier-middleware/debug/index`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/index.js`
|
||||
**Lines:** 25
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
_No named `export` / `module.exports` keys detected._
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./config.js`
|
||||
- `./logger.js`
|
||||
- `./redact.js`
|
||||
- `./trace.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
_No local call identifiers extracted._
|
||||
|
||||
## 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`.
|
||||
|
||||
47
docs/modules/verae-zapier-middleware/debug/logger.md
Normal file
47
docs/modules/verae-zapier-middleware/debug/logger.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# `verae-zapier-middleware/debug/logger`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/logger.js`
|
||||
**Lines:** 122
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`setDebugTestSink`, `formatLogLine`, `createDebugger`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `setDebugTestSink` | `sink` | sink: `null|((line: string) => void)` | `void` | see Call graph |
|
||||
| `formatLogLine` | `{ level, namespace, message, meta, traceId }` | parts: `object`, parts.level: `string`, parts.namespace: `string`, parts.message: `string`, parts.meta: `Record<string, unknown>|undefined`, parts.traceId: `string|null` | `string` | see Call graph |
|
||||
| `emit` | `line, filePath` | line: `string`, filePath: `string|null` | `void` | see Call graph |
|
||||
| `createDebugger` | `namespace` | namespace: `string` | `Debugger` — Logger with debug/info/warn/error methods. | see Call graph |
|
||||
| `write` | `level, message, meta` | level: `'debug'|'info'|'warn'|'error'`, message: `string`, meta: `Record<string, unknown>` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `./config.js`
|
||||
- `./redact.js`
|
||||
- `./trace-context.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`setDebugTestSink`, `formatLogLine`, `toISOString`, `keys`, `stringify`, `redact`, `toUpperCase`, `emit`, `testSink`, `error`, `appendFileSync`, `createDebugger`, `debug`, `toLowerCase`, `write`, `loadDebugConfig`, `shouldLog`, `getTraceId`
|
||||
|
||||
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`.
|
||||
|
||||
41
docs/modules/verae-zapier-middleware/debug/redact.md
Normal file
41
docs/modules/verae-zapier-middleware/debug/redact.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# `verae-zapier-middleware/debug/redact`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/redact.js`
|
||||
**Lines:** 94
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`redactString`, `redact`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `redactString` | `value` | value: `string` | `string` — Original or `[REDACTED]`. | see Call graph |
|
||||
| `redact` | `input, depth = 0` | input: `unknown`, depth: `number` | `unknown` — Redacted structure safe for logging. | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`redactString`, `test`, `redact`, `isArray`, `map`, `entries`, `has`, `toLowerCase`
|
||||
|
||||
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`.
|
||||
|
||||
43
docs/modules/verae-zapier-middleware/debug/trace-context.md
Normal file
43
docs/modules/verae-zapier-middleware/debug/trace-context.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# `verae-zapier-middleware/debug/trace-context`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/trace-context.js`
|
||||
**Lines:** 40
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`traceStorage`, `generateTraceId`, `getTraceId`, `getTraceContext`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `generateTraceId` | `(none)` | — | `string` | see Call graph |
|
||||
| `getTraceId` | `(none)` | — | `string|null` | see Call graph |
|
||||
| `getTraceContext` | `(none)` | — | `TraceContext|null` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:async_hooks`
|
||||
- `node:crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`context`, `id`, `generateTraceId`, `randomBytes`, `toString`, `getTraceId`, `getStore`, `getTraceContext`
|
||||
|
||||
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`.
|
||||
|
||||
48
docs/modules/verae-zapier-middleware/debug/trace.md
Normal file
48
docs/modules/verae-zapier-middleware/debug/trace.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
# `verae-zapier-middleware/debug/trace`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/trace.js`
|
||||
**Lines:** 96
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`withTrace`, `traceMiddleware`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `withTrace` | `options, fn` | options: `object|(() => T|Promise<T>)`, options.traceId: `string`, options.span: `string`, fn: `() => T|Promise<T>` | `T|Promise<T>` — Return value of `fn`. | see Call graph |
|
||||
| `traceMiddleware` | `req, res, next` | req: `import('express').Request`, res: `import('express').Response`, next: `import('express').NextFunction` | `void` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `withTrace` | `{ traceId, span: `${req.method} ${req.path}` }, (` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./logger.js`
|
||||
- `./trace-context.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `id`, `span`, `withTrace`, `async`, `getTraceId`, `getStore`, `generateTraceId`, `run`, `debug`, `callback`, `then`, `import`, `traceMiddleware`, `trim`, `setHeader`, `next`
|
||||
|
||||
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