Add NATS account-balance SoT and statement review for customers, CS, and sales
Some checks are pending
offline / test (push) Waiting to run
Some checks are pending
offline / test (push) Waiting to run
Internal billing now uses verae.billing.* request-reply and pubs. zappier-account-balance tracks prepaid, credits, usage, and payments. Portal, admin, CS, and sales all review the same statement. Independent Forgejo repos stay split via push-module-repos.
This commit is contained in:
parent
a1a5b957fd
commit
ac38676645
35 changed files with 3078 additions and 130 deletions
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/supervisor.js`
|
||||
**Lines:** 511
|
||||
**Lines:** 528
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -10,7 +10,7 @@ Implementation module in `verae-fleet`. The tables below are extracted from the
|
|||
|
||||
## Exports
|
||||
|
||||
`Supervisor`
|
||||
`spawnLocal`, `Supervisor`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
|
|
@ -22,6 +22,7 @@ Implementation module in `verae-fleet`. The tables below are extracted from the
|
|||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `spawnLocal` | `root, spec, env, healthPort` | — | `unknown` | see Call graph |
|
||||
| `waitExit` | `child, ms` | — | `unknown` | see Call graph |
|
||||
| `waitForHealth` | `rec, ms` | — | `unknown` | see Call graph |
|
||||
|
||||
|
|
@ -70,7 +71,7 @@ Implementation module in `verae-fleet`. The tables below are extracted from the
|
|||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`floor`, `join`, `dirname`, `fileURLToPath`, `constructor`, `loadFleet`, `mkdirSync`, `isArray`, `machines`, `addMachine`, `upsertMachine`, `saveOverlay`, `log`, `setMachineEnabled`, `find`, `checkMachine`, `sshCheck`, `httpProbe`, `machineOf`, `controlInstance`, `sshHttp`, `postControl`, `toISOString`, `push`, `splice`, `spec`, `nextIndex`, `values`, `filter`, `map`, `has`, `startOne`, `get`, `pickMachine`, `sshSpawnWorker`, `spawn`, `now`, `on`, `set`, `waitForHealth`, `stopInstance`, `sshKillWorker`, `kill`, `waitExit`, `delete`, `reconcile`, `pauseInstance`, `resumeInstance`, `restartInstance`, `markUnhealthy`, `probe`, `isFinite`, `summarizeRtt`, `available`, `keys`, `min`, `startService`, `stopService`, `pauseService`, `resumeService`
|
||||
`floor`, `join`, `dirname`, `fileURLToPath`, `apps`, `spawnLocal`, `resolve`, `spawn`, `constructor`, `loadFleet`, `mkdirSync`, `isArray`, `machines`, `addMachine`, `upsertMachine`, `saveOverlay`, `log`, `setMachineEnabled`, `find`, `checkMachine`, `sshCheck`, `httpProbe`, `machineOf`, `controlInstance`, `sshHttp`, `postControl`, `toISOString`, `push`, `splice`, `spec`, `nextIndex`, `values`, `filter`, `map`, `has`, `startOne`, `get`, `pickMachine`, `sshSpawnWorker`, `now`, `on`, `set`, `waitForHealth`, `stopInstance`, `sshKillWorker`, `kill`, `waitExit`, `delete`, `reconcile`, `pauseInstance`, `resumeInstance`, `restartInstance`, `markUnhealthy`, `probe`, `isFinite`, `summarizeRtt`, `available`, `keys`, `min`, `startService`
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
54
docs/sphinx/modules/zappier-account-balance/books.md
Normal file
54
docs/sphinx/modules/zappier-account-balance/books.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
# `zappier-account-balance/books`
|
||||
|
||||
**Package:** `zappier-account-balance`
|
||||
**Source:** `packages/zappier-account-balance/src/books.js`
|
||||
**Lines:** 90
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier-account-balance`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`AccountBooks`, `handle`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `AccountBooks` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `handle` | `subject, payload, books` | — | `unknown` | see Call graph |
|
||||
| `match` | `rows` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `(none)` |
|
||||
| `prepaidCents` | `customerId` |
|
||||
| `adjust` | `{ customerId, cents, reason, agent, kind = 'credit' }` |
|
||||
| `recordUsage` | `entry` |
|
||||
| `recordPayment` | `entry` |
|
||||
| `statement` | `customerId` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`constructor`, `prepaidCents`, `adjust`, `trunc`, `now`, `toString`, `random`, `slice`, `toISOString`, `unshift`, `recordUsage`, `recordPayment`, `statement`, `filter`, `match`, `handle`, `endsWith`
|
||||
|
||||
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`.
|
||||
|
||||
7
docs/sphinx/modules/zappier-account-balance/books.rst
Normal file
7
docs/sphinx/modules/zappier-account-balance/books.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
zappier-account-balance.books
|
||||
=============================
|
||||
|
||||
Generated API sheet for ``zappier-account-balance/books``.
|
||||
|
||||
.. include:: books.md
|
||||
:parser: myst_parser.sphinx_
|
||||
53
docs/sphinx/modules/zappier-account-balance/server.md
Normal file
53
docs/sphinx/modules/zappier-account-balance/server.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# `zappier-account-balance/server`
|
||||
|
||||
**Package:** `zappier-account-balance`
|
||||
**Source:** `packages/zappier-account-balance/src/server.js`
|
||||
**Lines:** 93
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier-account-balance`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
_No named `export` / `module.exports` keys detected._
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `startNats` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `readBody` | `req` | — | `unknown` | see Call graph |
|
||||
| `reply` | `sub, fn` | — | `unknown` | see Call graph |
|
||||
| `json` | `code, obj` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `reply` | `nc.subscribe(SUBJECTS.STATEMENT_GET, { queue: SUBJECTS.QUEUE }` |
|
||||
| `reply` | `nc.subscribe(SUBJECTS.BALANCE_GET, { queue: SUBJECTS.QUEUE }` |
|
||||
| `reply` | `nc.subscribe(SUBJECTS.BALANCE_ADJUST, { queue: SUBJECTS.QUEUE }` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `./books.js`
|
||||
- `./subjects.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`startNats`, `import`, `connect`, `split`, `async`, `parse`, `decode`, `fn`, `respond`, `encode`, `stringify`, `reply`, `subscribe`, `handle`, `write`, `readBody`, `on`, `push`, `resolve`, `concat`, `toString`, `createServer`, `writeHead`, `end`, `json`, `match`, `statement`, `adjust`, `listen`
|
||||
|
||||
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`.
|
||||
|
||||
7
docs/sphinx/modules/zappier-account-balance/server.rst
Normal file
7
docs/sphinx/modules/zappier-account-balance/server.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
zappier-account-balance.server
|
||||
==============================
|
||||
|
||||
Generated API sheet for ``zappier-account-balance/server``.
|
||||
|
||||
.. include:: server.md
|
||||
:parser: myst_parser.sphinx_
|
||||
36
docs/sphinx/modules/zappier-account-balance/subjects.md
Normal file
36
docs/sphinx/modules/zappier-account-balance/subjects.md
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
# `zappier-account-balance/subjects`
|
||||
|
||||
**Package:** `zappier-account-balance`
|
||||
**Source:** `packages/zappier-account-balance/src/subjects.js`
|
||||
**Lines:** 11
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier-account-balance`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`SUBJECTS`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## 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`.
|
||||
|
||||
7
docs/sphinx/modules/zappier-account-balance/subjects.rst
Normal file
7
docs/sphinx/modules/zappier-account-balance/subjects.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
zappier-account-balance.subjects
|
||||
================================
|
||||
|
||||
Generated API sheet for ``zappier-account-balance/subjects``.
|
||||
|
||||
.. include:: subjects.md
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
# `zappier-accounting-export/nats-billing`
|
||||
|
||||
**Package:** `zappier-accounting-export`
|
||||
**Source:** `packages/zappier-accounting-export/src/nats-billing.js`
|
||||
**Lines:** 18
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier-accounting-export`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`SUBJECTS`, `billingRequest`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `billingRequest` | `subject, payload` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`billingRequest`, `import`, `connect`, `split`, `request`, `encode`, `stringify`, `parse`, `decode`, `close`
|
||||
|
||||
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,7 @@
|
|||
zappier-accounting-export.nats-billing
|
||||
======================================
|
||||
|
||||
Generated API sheet for ``zappier-accounting-export/nats-billing``.
|
||||
|
||||
.. include:: nats-billing.md
|
||||
:parser: myst_parser.sphinx_
|
||||
46
docs/sphinx/modules/zappier-accounting-export/server.md
Normal file
46
docs/sphinx/modules/zappier-accounting-export/server.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# `zappier-accounting-export/server`
|
||||
|
||||
**Package:** `zappier-accounting-export`
|
||||
**Source:** `packages/zappier-accounting-export/src/server.js`
|
||||
**Lines:** 62
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier-accounting-export`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
_No named `export` / `module.exports` keys detected._
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `edge` | `pathname` | — | `unknown` | see Call graph |
|
||||
| `send` | `code, type, body` | — | `unknown` | see Call graph |
|
||||
| `json` | `code, obj` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `node:http`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./nats-billing.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`replace`, `join`, `dirname`, `fileURLToPath`, `edge`, `fetch`, `createServer`, `async`, `writeHead`, `end`, `send`, `stringify`, `readFileSync`, `json`, `match`, `billingRequest`, `text`, `get`, `encodeURIComponent`, `listen`, `write`
|
||||
|
||||
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`.
|
||||
|
||||
7
docs/sphinx/modules/zappier-accounting-export/server.rst
Normal file
7
docs/sphinx/modules/zappier-accounting-export/server.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
zappier-accounting-export.server
|
||||
================================
|
||||
|
||||
Generated API sheet for ``zappier-accounting-export/server``.
|
||||
|
||||
.. include:: server.md
|
||||
:parser: myst_parser.sphinx_
|
||||
40
docs/sphinx/modules/zappier-customer-service/nats-billing.md
Normal file
40
docs/sphinx/modules/zappier-customer-service/nats-billing.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# `zappier-customer-service/nats-billing`
|
||||
|
||||
**Package:** `zappier-customer-service`
|
||||
**Source:** `packages/zappier-customer-service/src/nats-billing.js`
|
||||
**Lines:** 21
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier-customer-service`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`SUBJECTS`, `billingRequest`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `billingRequest` | `subject, payload` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`billingRequest`, `import`, `connect`, `split`, `request`, `encode`, `stringify`, `parse`, `decode`, `close`
|
||||
|
||||
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,7 @@
|
|||
zappier-customer-service.nats-billing
|
||||
=====================================
|
||||
|
||||
Generated API sheet for ``zappier-customer-service/nats-billing``.
|
||||
|
||||
.. include:: nats-billing.md
|
||||
:parser: myst_parser.sphinx_
|
||||
45
docs/sphinx/modules/zappier-customer-service/server.md
Normal file
45
docs/sphinx/modules/zappier-customer-service/server.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# `zappier-customer-service/server`
|
||||
|
||||
**Package:** `zappier-customer-service`
|
||||
**Source:** `packages/zappier-customer-service/src/server.js`
|
||||
**Lines:** 81
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier-customer-service`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
_No named `export` / `module.exports` keys detected._
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `statement` | `customerId` | — | `unknown` | see Call graph |
|
||||
| `json` | `code, obj` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `node:http`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./nats-billing.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `dirname`, `fileURLToPath`, `replace`, `statement`, `billingRequest`, `fetch`, `json`, `createServer`, `async`, `writeHead`, `end`, `stringify`, `readFileSync`, `match`, `push`, `parse`, `concat`, `toString`, `get`, `listen`, `write`
|
||||
|
||||
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`.
|
||||
|
||||
7
docs/sphinx/modules/zappier-customer-service/server.rst
Normal file
7
docs/sphinx/modules/zappier-customer-service/server.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
zappier-customer-service.server
|
||||
===============================
|
||||
|
||||
Generated API sheet for ``zappier-customer-service/server``.
|
||||
|
||||
.. include:: server.md
|
||||
:parser: myst_parser.sphinx_
|
||||
40
docs/sphinx/modules/zappier-sales-pricing/nats-billing.md
Normal file
40
docs/sphinx/modules/zappier-sales-pricing/nats-billing.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# `zappier-sales-pricing/nats-billing`
|
||||
|
||||
**Package:** `zappier-sales-pricing`
|
||||
**Source:** `packages/zappier-sales-pricing/src/nats-billing.js`
|
||||
**Lines:** 18
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier-sales-pricing`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`SUBJECTS`, `billingRequest`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `billingRequest` | `subject, payload` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`billingRequest`, `import`, `connect`, `split`, `request`, `encode`, `stringify`, `parse`, `decode`, `close`
|
||||
|
||||
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,7 @@
|
|||
zappier-sales-pricing.nats-billing
|
||||
==================================
|
||||
|
||||
Generated API sheet for ``zappier-sales-pricing/nats-billing``.
|
||||
|
||||
.. include:: nats-billing.md
|
||||
:parser: myst_parser.sphinx_
|
||||
45
docs/sphinx/modules/zappier-sales-pricing/server.md
Normal file
45
docs/sphinx/modules/zappier-sales-pricing/server.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# `zappier-sales-pricing/server`
|
||||
|
||||
**Package:** `zappier-sales-pricing`
|
||||
**Source:** `packages/zappier-sales-pricing/src/server.js`
|
||||
**Lines:** 77
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier-sales-pricing`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
_No named `export` / `module.exports` keys detected._
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `edge` | `pathname, { method = 'GET', body } = {}` | — | `unknown` | see Call graph |
|
||||
| `json` | `code, obj` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `node:http`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./nats-billing.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `dirname`, `fileURLToPath`, `replace`, `edge`, `fetch`, `stringify`, `text`, `parse`, `createServer`, `async`, `writeHead`, `end`, `readFileSync`, `json`, `match`, `billingRequest`, `push`, `concat`, `toString`, `listen`, `write`
|
||||
|
||||
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`.
|
||||
|
||||
7
docs/sphinx/modules/zappier-sales-pricing/server.rst
Normal file
7
docs/sphinx/modules/zappier-sales-pricing/server.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
zappier-sales-pricing.server
|
||||
============================
|
||||
|
||||
Generated API sheet for ``zappier-sales-pricing/server``.
|
||||
|
||||
.. include:: server.md
|
||||
:parser: myst_parser.sphinx_
|
||||
43
docs/sphinx/modules/zappier/accounting-export.md
Normal file
43
docs/sphinx/modules/zappier/accounting-export.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# `zappier/accounting-export`
|
||||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/accounting-export.ts`
|
||||
**Lines:** 37
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`invoicesToQuickBooksIif`, `invoicesToAccountingCsv`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `iifDate` | `ms: number` | — | `unknown` | see Call graph |
|
||||
| `invoicesToQuickBooksIif` | `invoices: Invoice[]` | — | `unknown` | see Call graph |
|
||||
| | _QuickBooks IIF journal for issued/paid invoices (Accounts Receivable + Sales)._ | | | |
|
||||
| `invoicesToAccountingCsv` | `invoices: Invoice[]` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./invoicing`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`iifDate`, `getUTCMonth`, `padStart`, `getUTCDate`, `getUTCFullYear`, `invoices`, `invoicesToQuickBooksIif`, `now`, `toFixed`, `push`, `join`, `invoicesToAccountingCsv`, `map`
|
||||
|
||||
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`.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue