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
44
docs/modules/zappier/billing/credit.md
Normal file
44
docs/modules/zappier/billing/credit.md
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
# `zappier/billing/credit`
|
||||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/billing/credit.ts`
|
||||
**Lines:** 20
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`BilledSummary`, `applyMonthlyCredit`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| interface | `BilledSummary` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `applyMonthlyCredit` | `summary: UsageSummary,
|
||||
tier: TierConfig,` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../pricing`
|
||||
- `../usage`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`applyMonthlyCredit`, `min`
|
||||
|
||||
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/zappier/billing/reload.md
Normal file
43
docs/modules/zappier/billing/reload.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# `zappier/billing/reload`
|
||||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/billing/reload.ts`
|
||||
**Lines:** 32
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`stripePaymentClient`, `hasRealStripeKey`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `stripePaymentClient` | `secretKey: string` | — | `unknown` | see Call graph |
|
||||
| `hasRealStripeKey` | `key: string \| undefined` | — | `unknown` | see Call graph |
|
||||
| | _True when the key looks usable (not empty / not the setup placeholder)._ | | | |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `stripe`
|
||||
- `../portal`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`confirms`, `stripePaymentClient`, `async`, `create`, `usable`, `hasRealStripeKey`, `startsWith`
|
||||
|
||||
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`.
|
||||
|
||||
60
docs/modules/zappier/billing/stripe.md
Normal file
60
docs/modules/zappier/billing/stripe.md
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
# `zappier/billing/stripe`
|
||||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/billing/stripe.ts`
|
||||
**Lines:** 42
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`METER_EVENT_NAME`, `MeterEventClient`, `computeBillableCents`, `computeDelta`, `reportUsage`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| interface | `MeterEventClient` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `computeBillableCents` | `entries: UsageEntry[], monthlyCreditCents: number` | — | `unknown` | see Call graph |
|
||||
| | _Stripe-side dedup key; events with the same identifier are dropped._ | | | |
|
||||
| `computeDelta` | `billableCents: number, previouslyReportedCents: number` | — | `unknown` | see Call graph |
|
||||
| `reportUsage` | `client: MeterEventClient,
|
||||
stripeCustomerId: string,
|
||||
entries: UsageEntry[],
|
||||
monthlyCreditCents: number,` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `createMeterEvent` | `params: {
|
||||
eventName: string;
|
||||
customerId: string;
|
||||
value: string;
|
||||
/** Stripe-side dedup key; events with the same identifier are dropped. */
|
||||
identifier?: string;
|
||||
}` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../usage`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createMeterEvent`, `computeBillableCents`, `reduce`, `max`, `computeDelta`, `ts`, `reportUsage`
|
||||
|
||||
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