Document every repo in Sphinx, catalog PDFs, and verae-ops
Some checks are pending
offline / test (push) Waiting to run
Some checks are pending
offline / test (push) Waiting to run
Add missing package READMEs, expand Sphinx to all runtime modules, publish a LaTeX/PDF README book, and add verae-ops for Docker, Proxmox, VMs, dedicated hardware, and service linking. Catalog defaults to public PDF links for each module README and samples.
This commit is contained in:
parent
5ad3222def
commit
e401635fd6
222 changed files with 4498 additions and 123 deletions
|
|
@ -28,6 +28,10 @@ cd ../.. && npm run gate:0
|
|||
|
||||
Gates (`npm run gate:N`) continue the middleware plan in [TODO.md](TODO.md). Phases 0–8, 10, 11 already passed in the source tree; 9 and 12+ are still open. Path prefixes now use `packages/`.
|
||||
|
||||
**Live catalog (PDF default):** https://zapier.georgelambert.org/ · [Markdown indexes](https://zapier.georgelambert.org/index-md.html)
|
||||
**Install / Docker / Proxmox / metal:** https://zapier.georgelambert.org/packages/verae-ops/README.pdf
|
||||
**Sphinx:** https://zapier.georgelambert.org/sphinx/ · [LaTeX PDF](https://zapier.georgelambert.org/sphinx/verae-zapier-modules.pdf)
|
||||
|
||||
## Documentation map
|
||||
|
||||
| Doc | Contents |
|
||||
|
|
|
|||
|
|
@ -85,4 +85,29 @@ One MD file per source module.
|
|||
- [verae-zapier/index](verae-zapier/index.md)
|
||||
- [verae-zapier/searches/hash_lookup](verae-zapier/searches/hash_lookup.md)
|
||||
- [verae-zapier/searches/job_status](verae-zapier/searches/job_status.md)
|
||||
- [verae-zapier/searches/tree_lookup](verae-zapier/searches/tree_lookup.md)
|
||||
- [verae-zapier/triggers/timestamp_completed](verae-zapier/triggers/timestamp_completed.md)
|
||||
- [verae-fleet/agent](verae-fleet/agent.md)
|
||||
- [verae-fleet/classify](verae-fleet/classify.md)
|
||||
- [verae-fleet/cli](verae-fleet/cli.md)
|
||||
- [verae-fleet/health](verae-fleet/health.md)
|
||||
- [verae-fleet/load](verae-fleet/load.md)
|
||||
- [verae-fleet/machines](verae-fleet/machines.md)
|
||||
- [verae-fleet/monitor](verae-fleet/monitor.md)
|
||||
- [verae-fleet/rtt](verae-fleet/rtt.md)
|
||||
- [verae-fleet/server](verae-fleet/server.md)
|
||||
- [verae-fleet/ssh](verae-fleet/ssh.md)
|
||||
- [verae-fleet/supervisor](verae-fleet/supervisor.md)
|
||||
- [verae-fleet/worker](verae-fleet/worker.md)
|
||||
- [verae-tree-node/merkle](verae-tree-node/merkle.md)
|
||||
- [verae-archive-worm/archive](verae-archive-worm/archive.md)
|
||||
- [verae-archive-worm/bloom](verae-archive-worm/bloom.md)
|
||||
- [verae-archive-aggregator/aggregate](verae-archive-aggregator/aggregate.md)
|
||||
- [verae-request-splitter/splitRequest](verae-request-splitter/splitRequest.md)
|
||||
- [verae-nats-process/handle](verae-nats-process/handle.md)
|
||||
- [verae-nats-process/subjects](verae-nats-process/subjects.md)
|
||||
- [verae-nats-process/worker](verae-nats-process/worker.md)
|
||||
- [verae-zapier-simulator/monitors](verae-zapier-simulator/monitors.md)
|
||||
- [verae-zapier-simulator/pipeline](verae-zapier-simulator/pipeline.md)
|
||||
- [verae-zapier-simulator/server](verae-zapier-simulator/server.md)
|
||||
- [verae-zapier-simulator/trace](verae-zapier-simulator/trace.md)
|
||||
|
|
|
|||
41
docs/modules/verae-archive-aggregator/aggregate.md
Normal file
41
docs/modules/verae-archive-aggregator/aggregate.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# `verae-archive-aggregator/aggregate`
|
||||
|
||||
**Package:** `verae-archive-aggregator`
|
||||
**Source:** `packages/verae-archive-aggregator/src/aggregate.js`
|
||||
**Lines:** 67
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-archive-aggregator`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`aggregateAttached`, `mergeReceipts`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `aggregateAttached` | `{ sha256, tenantId, kinds = ['publicMeta', 'privateMeta', 'file'], archives }` | opts: `object`, opts.sha256: `string`, opts.tenantId: `string`, opts.kinds: `string[]`, opts.timeoutMs: `number` | `{ archivesQueried: boolean, archiveReplies: number, records: object[], silent: string[] ` — } | see Call graph |
|
||||
| `mergeReceipts` | `chainReceipts, archiveRecords` | chainReceipts: `object[]`, archiveRecords: `object[]` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`mock`, `aggregateAttached`, `query`, `push`, `includes`, `mergeReceipts`, `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`.
|
||||
|
||||
48
docs/modules/verae-archive-worm/archive.md
Normal file
48
docs/modules/verae-archive-worm/archive.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
# `verae-archive-worm/archive`
|
||||
|
||||
**Package:** `verae-archive-worm`
|
||||
**Source:** `packages/verae-archive-worm/src/archive.js`
|
||||
**Lines:** 41
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-archive-worm`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`WormArchive`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `WormArchive` |
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `archiveId` |
|
||||
| `put` | `put` |
|
||||
| `query` | `sha256` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./bloom.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`constructor`, `put`, `toLowerCase`, `get`, `push`, `toISOString`, `set`, `add`, `null`, `records`, `query`, `mightHave`
|
||||
|
||||
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`.
|
||||
|
||||
49
docs/modules/verae-archive-worm/bloom.md
Normal file
49
docs/modules/verae-archive-worm/bloom.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# `verae-archive-worm/bloom`
|
||||
|
||||
**Package:** `verae-archive-worm`
|
||||
**Source:** `packages/verae-archive-worm/src/bloom.js`
|
||||
**Lines:** 47
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-archive-worm`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`Bloom`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `Bloom` |
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `m = 16384, k = 4` |
|
||||
| `hashes` | `s` |
|
||||
| `add` | `s` |
|
||||
| `mightHave` | `s` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`membership`, `constructor`, `alloc`, `ceil`, `hashes`, `createHash`, `update`, `digest`, `readUInt32BE`, `push`, `add`, `maybe`, `mightHave`, `every`
|
||||
|
||||
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`.
|
||||
|
||||
51
docs/modules/verae-fleet/agent.md
Normal file
51
docs/modules/verae-fleet/agent.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# `verae-fleet/agent`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/agent.js`
|
||||
**Lines:** 87
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startAgent`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `json` | `res, code, obj` | — | `unknown` | see Call graph |
|
||||
| `readBody` | `req` | — | `unknown` | see Call graph |
|
||||
| `startAgent` | `{ port = PORT, bind = BIND } = {}` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `startAgent` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:child_process`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `dirname`, `fileURLToPath`, `json`, `writeHead`, `end`, `stringify`, `readBody`, `push`, `concat`, `toString`, `parse`, `startAgent`, `createServer`, `async`, `keys`, `has`, `get`, `spawn`, `set`, `on`, `delete`, `kill`, `listen`, `write`, `close`, `values`, `clear`, `basename`
|
||||
|
||||
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`.
|
||||
|
||||
40
docs/modules/verae-fleet/classify.md
Normal file
40
docs/modules/verae-fleet/classify.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# `verae-fleet/classify`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/classify.js`
|
||||
**Lines:** 30
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`classifyService`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `classifyService` | `sv` | — | `'operational'|'degraded'|'down'` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`classifyService`, `filter`
|
||||
|
||||
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`.
|
||||
|
||||
62
docs/modules/verae-fleet/cli.md
Normal file
62
docs/modules/verae-fleet/cli.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
# `verae-fleet/cli`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/cli.js`
|
||||
**Lines:** 146
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. 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) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `print` | `obj` | — | `unknown` | see Call graph |
|
||||
| `help` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `api` | `method, pathname` | — | `unknown` | see Call graph |
|
||||
| `main` | `(none)` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `print` | ``verae-fleet
|
||||
|
||||
list services, config files, replica min/max
|
||||
serve start floors + monitor + UI ${BASE}/
|
||||
monitor same without printing extra
|
||||
status GET daemon status
|
||||
start <service> turn on, spawn up to min
|
||||
stop <service|instance> turn off (service disable` |
|
||||
| `print` | `r.body` |
|
||||
| `print` | `{ error: err.message, hint: 'Is `verae-fleet serve` running?' }` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `./load.js`
|
||||
- `./supervisor.js`
|
||||
- `./monitor.js`
|
||||
- `./server.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`loadFleet`, `slice`, `print`, `write`, `stringify`, `help`, `off`, `pause`, `json`, `identityFile`, `login`, `api`, `request`, `on`, `push`, `concat`, `toString`, `resolve`, `parse`, `end`, `main`, `listServices`, `padEnd`, `padStart`, `import`, `find`, `sshCheck`, `keys`, `startService`, `tick`, `start`, `startControlServer`, `async`, `stop`, `stopAll`, `exit`, `test`
|
||||
|
||||
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`.
|
||||
|
||||
47
docs/modules/verae-fleet/health.md
Normal file
47
docs/modules/verae-fleet/health.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# `verae-fleet/health`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/health.js`
|
||||
**Lines:** 119
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`httpProbe`, `tcpProbe`, `postControl`, `heartbeatFresh`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `httpProbe` | `portOrOpts, pathname = '/health', timeoutMs = 800` | — | `unknown` | see Call graph |
|
||||
| `tcpProbe` | `host, port, timeoutMs = 400` | — | `unknown` | see Call graph |
|
||||
| `postControl` | `portOrOpts, pathname = '/'` | pathname: `string` | `unknown` | see Call graph |
|
||||
| `heartbeatFresh` | `stateDir, maxAgeMs` | — | `unknown` | see Call graph |
|
||||
| `done` | `ok, error` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:net`
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`httpProbe`, `get`, `on`, `push`, `parse`, `concat`, `toString`, `resolve`, `destroy`, `tcpProbe`, `connect`, `setTimeout`, `done`, `postControl`, `stringify`, `request`, `byteLength`, `write`, `end`, `heartbeatFresh`, `join`, `statSync`, `readFileSync`, `now`
|
||||
|
||||
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`.
|
||||
|
||||
45
docs/modules/verae-fleet/load.md
Normal file
45
docs/modules/verae-fleet/load.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# `verae-fleet/load`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/load.js`
|
||||
**Lines:** 95
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`FLEET_ROOT`, `readJson`, `loadFleet`, `listServices`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `readJson` | `file` | — | `unknown` | see Call graph |
|
||||
| `loadFleet` | `root = FLEET_ROOT, opts = {}` | root: `string` | `unknown` | see Call graph |
|
||||
| `listServices` | `loaded` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./machines.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`dirname`, `fileURLToPath`, `resolve`, `readJson`, `parse`, `readFileSync`, `loadFleet`, `join`, `readdirSync`, `sort`, `endsWith`, `push`, `loadMachines`, `relative`, `listServices`, `values`, `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`.
|
||||
|
||||
47
docs/modules/verae-fleet/machines.md
Normal file
47
docs/modules/verae-fleet/machines.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# `verae-fleet/machines`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/machines.js`
|
||||
**Lines:** 108
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`defaultMachines`, `loadMachines`, `normalizeMachine`, `upsertMachine`, `canHost`, `pickMachine`, `saveOverlay`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `defaultMachines` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `loadMachines` | `root, overlayPath` | — | `unknown` | see Call graph |
|
||||
| `normalizeMachine` | `m` | — | `unknown` | see Call graph |
|
||||
| `upsertMachine` | `list, spec` | — | `unknown` | see Call graph |
|
||||
| `canHost` | `machine, serviceId, role` | — | `unknown` | see Call graph |
|
||||
| `pickMachine` | `machines, instances, serviceId, role, exclude = []` | machines: `object[]`, serviceId: `string`, role: `string` | `unknown` | see Call graph |
|
||||
| `saveOverlay` | `overlayPath, machines` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`defaultMachines`, `plane`, `loadMachines`, `join`, `existsSync`, `parse`, `readFileSync`, `isArray`, `upsertMachine`, `assign`, `map`, `normalizeMachine`, `trim`, `findIndex`, `push`, `canHost`, `includes`, `capacity`, `pickMachine`, `filter`, `has`, `sort`, `localeCompare`, `find`, `saveOverlay`, `mkdirSync`, `dirname`, `writeFileSync`, `stringify`
|
||||
|
||||
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`.
|
||||
|
||||
49
docs/modules/verae-fleet/monitor.md
Normal file
49
docs/modules/verae-fleet/monitor.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# `verae-fleet/monitor`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/monitor.js`
|
||||
**Lines:** 39
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`Monitor`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `Monitor` |
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `supervisor, opts = {}` |
|
||||
| `tick` | `(none)` |
|
||||
| `start` | `(none)` |
|
||||
| `stop` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`floors`, `import`, `constructor`, `tick`, `reconcile`, `toISOString`, `status`, `start`, `setInterval`, `log`, `stop`, `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`.
|
||||
|
||||
52
docs/modules/verae-fleet/rtt.md
Normal file
52
docs/modules/verae-fleet/rtt.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
# `verae-fleet/rtt`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/rtt.js`
|
||||
**Lines:** 58
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`RttWindow`, `summarizeRtt`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `RttWindow` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `summarizeRtt` | `samples` | samples: `number[]` | `unknown` | see Call graph |
|
||||
| `percentile` | `sorted, p` | — | `unknown` | see Call graph |
|
||||
| `round1` | `n` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `cap = 400` |
|
||||
| `add` | `ms` |
|
||||
| `stats` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`constructor`, `add`, `isFinite`, `push`, `splice`, `stats`, `summarizeRtt`, `filter`, `slice`, `sort`, `reduce`, `round1`, `percentile`, `floor`, `ceil`, `round`
|
||||
|
||||
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`.
|
||||
|
||||
46
docs/modules/verae-fleet/server.md
Normal file
46
docs/modules/verae-fleet/server.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# `verae-fleet/server`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/server.js`
|
||||
**Lines:** 146
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startControlServer`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `json` | `res, code, obj` | — | `unknown` | see Call graph |
|
||||
| `startControlServer` | `sup, mon` | sup: `import('./supervisor.js').Supervisor`, mon: `import('./monitor.js').Monitor` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./load.js`
|
||||
- `../../verae-zapier-simulator/src/pipeline.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `dirname`, `fileURLToPath`, `json`, `writeHead`, `end`, `stringify`, `import`, `startControlServer`, `createServer`, `async`, `snapshot`, `reset`, `push`, `parse`, `concat`, `toString`, `run`, `listServices`, `status`, `addMachine`, `match`, `checkMachine`, `setMachineEnabled`, `reconcile`, `startService`, `stopService`, `pauseService`, `resumeService`, `fn`, `pauseInstance`, `resumeInstance`, `restartInstance`, `stopInstance`, `markUnhealthy`, `createReadStream`, `pipe`, `startsWith`, `normalize`, `existsSync`, `statSync`, `isFile`, `extname`, `toLowerCase`, `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`.
|
||||
|
||||
55
docs/modules/verae-fleet/ssh.md
Normal file
55
docs/modules/verae-fleet/ssh.md
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
# `verae-fleet/ssh`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/ssh.js`
|
||||
**Lines:** 171
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`expandHome`, `shellQuote`, `sshTarget`, `sshBaseArgs`, `scpBaseArgs`, `sshExec`, `scpTo`, `ensureRemoteRuntime`, `sshSpawnWorker`, `sshKillWorker`, `sshHttp`, `sshCheck`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `expandHome` | `p` | — | `unknown` | see Call graph |
|
||||
| `shellQuote` | `s` | — | `unknown` | see Call graph |
|
||||
| `sshTarget` | `machine` | — | `unknown` | see Call graph |
|
||||
| `sshBaseArgs` | `machine` | — | `unknown` | see Call graph |
|
||||
| `scpBaseArgs` | `machine` | — | `unknown` | see Call graph |
|
||||
| `sshExec` | `machine, remoteCommand, { timeoutMs = 20000 } = {}` | — | `unknown` | see Call graph |
|
||||
| `scpTo` | `machine, localFiles, remoteDir` | — | `unknown` | see Call graph |
|
||||
| `ensureRemoteRuntime` | `machine` | — | `unknown` | see Call graph |
|
||||
| `sshSpawnWorker` | `machine, { instance, env }` | — | `unknown` | see Call graph |
|
||||
| `sshKillWorker` | `machine, pid, instance` | — | `unknown` | see Call graph |
|
||||
| `sshHttp` | `machine, method, urlPath, { port, body } = {}` | — | `unknown` | see Call graph |
|
||||
| `sshCheck` | `machine` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:child_process`
|
||||
- `node:fs`
|
||||
- `node:os`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`dirname`, `fileURLToPath`, `expandHome`, `homedir`, `startsWith`, `join`, `slice`, `shellQuote`, `replace`, `sshTarget`, `sshBaseArgs`, `existsSync`, `push`, `scpBaseArgs`, `sshExec`, `spawn`, `on`, `setTimeout`, `kill`, `reject`, `clearTimeout`, `concat`, `toString`, `trim`, `resolve`, `scpTo`, `ensureRemoteRuntime`, `has`, `add`, `sshSpawnWorker`, `entries`, `filter`, `map`, `split`, `pop`, `isFinite`, `sshKillWorker`, `sshHttp`, `stringify`, `parse`, `sshCheck`
|
||||
|
||||
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`.
|
||||
|
||||
82
docs/modules/verae-fleet/supervisor.md
Normal file
82
docs/modules/verae-fleet/supervisor.md
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
# `verae-fleet/supervisor`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/supervisor.js`
|
||||
**Lines:** 511
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`Supervisor`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `Supervisor` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `waitExit` | `child, ms` | — | `unknown` | see Call graph |
|
||||
| `waitForHealth` | `rec, ms` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `opts = {}` |
|
||||
| `machines` | `(none)` |
|
||||
| `addMachine` | `spec` |
|
||||
| `setMachineEnabled` | `id, enabled` |
|
||||
| `checkMachine` | `id` |
|
||||
| `machineOf` | `rec` |
|
||||
| `controlInstance` | `rec, pathname, body` |
|
||||
| `log` | `type, detail` |
|
||||
| `spec` | `serviceId` |
|
||||
| `nextIndex` | `serviceId` |
|
||||
| `startOne` | `serviceId, opts = {}` |
|
||||
| `stopInstance` | `instanceId, { replace = true } = {}` |
|
||||
| `pauseInstance` | `instanceId, { replace = true } = {}` |
|
||||
| `resumeInstance` | `instanceId` |
|
||||
| `restartInstance` | `instanceId` |
|
||||
| `markUnhealthy` | `instanceId` |
|
||||
| `probe` | `rec` |
|
||||
| `available` | `serviceId` |
|
||||
| `reconcile` | `only` |
|
||||
| `startService` | `serviceId` |
|
||||
| `stopService` | `serviceId, { holdFloor = false } = {}` |
|
||||
| `pauseService` | `serviceId` |
|
||||
| `resumeService` | `serviceId` |
|
||||
| `stopAll` | `(none)` |
|
||||
| `status` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:child_process`
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./load.js`
|
||||
- `./health.js`
|
||||
- `./classify.js`
|
||||
- `./machines.js`
|
||||
- `./rtt.js`
|
||||
- `./ssh.js`
|
||||
|
||||
## 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`
|
||||
|
||||
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`.
|
||||
|
||||
57
docs/modules/verae-fleet/worker.md
Normal file
57
docs/modules/verae-fleet/worker.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
# `verae-fleet/worker`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/worker.js`
|
||||
**Lines:** 154
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. 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) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `processMessage` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `snapshot` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `beat` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `shutdown` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `json` | `code, obj` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `json` | `404, { error: 'not found' }` |
|
||||
| `beat` | `(none)` |
|
||||
| `clearInterval` | `iv` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `node:crypto`
|
||||
- `node:url`
|
||||
- `./rtt.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `cwd`, `toISOString`, `mkdirSync`, `resolve`, `dirname`, `fileURLToPath`, `import`, `put`, `query`, `processMessage`, `bigint`, `randomBytes`, `createHash`, `update`, `digest`, `add`, `snapshot`, `stats`, `beat`, `now`, `writeFileSync`, `stringify`, `createServer`, `writeHead`, `end`, `json`, `slice`, `listen`, `write`, `setInterval`, `max`, `round`, `shutdown`, `clearInterval`, `close`, `exit`, `on`
|
||||
|
||||
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`.
|
||||
|
||||
40
docs/modules/verae-nats-process/handle.md
Normal file
40
docs/modules/verae-nats-process/handle.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# `verae-nats-process/handle`
|
||||
|
||||
**Package:** `verae-nats-process`
|
||||
**Source:** `packages/verae-nats-process/src/handle.js`
|
||||
**Lines:** 21
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-nats-process`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`handle`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `handle` | `msg = {}` | msg: `object` | `Promise<object>|object` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`handle`, `toISOString`
|
||||
|
||||
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`.
|
||||
|
||||
38
docs/modules/verae-nats-process/subjects.md
Normal file
38
docs/modules/verae-nats-process/subjects.md
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
# `verae-nats-process/subjects`
|
||||
|
||||
**Package:** `verae-nats-process`
|
||||
**Source:** `packages/verae-nats-process/src/subjects.js`
|
||||
**Lines:** 14
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-nats-process`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`AREA`, `RESOURCE`, `SUBJECTS`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`freeze`
|
||||
|
||||
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`.
|
||||
|
||||
49
docs/modules/verae-nats-process/worker.md
Normal file
49
docs/modules/verae-nats-process/worker.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# `verae-nats-process/worker`
|
||||
|
||||
**Package:** `verae-nats-process`
|
||||
**Source:** `packages/verae-nats-process/src/worker.js`
|
||||
**Lines:** 71
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-nats-process`. 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) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `snapshot` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `json` | `code, obj` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `json` | `404, { error: 'not found' }` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `./subjects.js`
|
||||
- `./handle.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`snapshot`, `createServer`, `async`, `writeHead`, `end`, `stringify`, `json`, `push`, `parse`, `concat`, `toString`, `handle`, `reply`, `listen`, `write`, `on`, `close`, `exit`
|
||||
|
||||
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`.
|
||||
|
||||
42
docs/modules/verae-request-splitter/splitRequest.md
Normal file
42
docs/modules/verae-request-splitter/splitRequest.md
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# `verae-request-splitter/splitRequest`
|
||||
|
||||
**Package:** `verae-request-splitter`
|
||||
**Source:** `packages/verae-request-splitter/src/splitRequest.js`
|
||||
**Lines:** 72
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-request-splitter`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`sha256Hex`, `splitRequest`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `sha256Hex` | `data` | data: `string` | `string` | see Call graph |
|
||||
| `splitRequest` | `body = {}` | body: `object` | `{
|
||||
* chain: { sha256: string, hashAlg: string, data?: string ` — , | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`sha256Hex`, `createHash`, `update`, `digest`, `splitRequest`, `toLowerCase`, `keys`, `push`, `isArray`, `from`, `toString`
|
||||
|
||||
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`.
|
||||
|
||||
45
docs/modules/verae-tree-node/merkle.md
Normal file
45
docs/modules/verae-tree-node/merkle.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# `verae-tree-node/merkle`
|
||||
|
||||
**Package:** `verae-tree-node`
|
||||
**Source:** `packages/verae-tree-node/src/merkle.js`
|
||||
**Lines:** 97
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-tree-node`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`sha256Hex`, `parentHash`, `buildMerkle`, `merkleProof`, `verifyProof`, `shardIndex`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `sha256Hex` | `data` | data: `string|Buffer|Uint8Array` | `string` — lowercase hex | see Call graph |
|
||||
| `parentHash` | `left, right` | left: `string`, right: `string` | `unknown` | see Call graph |
|
||||
| `buildMerkle` | `leaves` | leaves: `string[]` | `{ root: string, layers: string[][], leaves: string[] ` — } | see Call graph |
|
||||
| `merkleProof` | `layers, index` | layers: `string[][]`, index: `number` | `Array<{ sibling: string, position: 'left'|'right' ` — >} | see Call graph |
|
||||
| `verifyProof` | `leaf, proof, root` | leaf: `string`, root: `string` | `unknown` | see Call graph |
|
||||
| `shardIndex` | `sha256, n` | sha256: `string`, n: `number` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`sha256Hex`, `isBuffer`, `from`, `createHash`, `update`, `digest`, `children`, `duplicated`, `parentHash`, `buildMerkle`, `map`, `toLowerCase`, `push`, `merkleProof`, `floor`, `verifyProof`, `nodes`, `shardIndex`, `slice`, `readUInt32BE`
|
||||
|
||||
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`.
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/nats/subjects.js`
|
||||
**Lines:** 44
|
||||
**Lines:** 48
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -26,7 +26,7 @@ _No imports detected._
|
|||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`freeze`, `names`
|
||||
`freeze`, `node`, `names`
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/routes/hashRoutes.js`
|
||||
**Lines:** 22
|
||||
**Lines:** 24
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/timestampService.js`
|
||||
**Lines:** 160
|
||||
**Lines:** 170
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ _None extracted._
|
|||
| `getJobStatus` | `ctx, jobId` | ctx: `object`, jobId: `string` | `unknown` | see Call graph |
|
||||
| `getBatchJobStatus` | `ctx, body` | ctx: `object` | `unknown` | see Call graph |
|
||||
| `getJobVerification` | `ctx, jobId` | ctx: `object`, jobId: `string` | `unknown` | see Call graph |
|
||||
| `lookupHash` | `ctx, sha256` | ctx: `object`, sha256: `string` | `unknown` | see Call graph |
|
||||
| `lookupHash` | `ctx, sha256, opts = {}` | ctx: `object`, sha256: `string` | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
|
|
|
|||
40
docs/modules/verae-zapier-simulator/monitors.md
Normal file
40
docs/modules/verae-zapier-simulator/monitors.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# `verae-zapier-simulator/monitors`
|
||||
|
||||
**Package:** `verae-zapier-simulator`
|
||||
**Source:** `packages/verae-zapier-simulator/src/monitors.js`
|
||||
**Lines:** 221
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-simulator`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`analyze`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `analyze` | `events, ctx = {}` | events: `object[]`, ctx: `object` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`check`, `filter`, `startsWith`, `includes`, `keys`, `join`, `broadcast`, `hop`, `analyze`, `push`, `map`, `find`, `some`
|
||||
|
||||
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`.
|
||||
|
||||
58
docs/modules/verae-zapier-simulator/pipeline.md
Normal file
58
docs/modules/verae-zapier-simulator/pipeline.md
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
# `verae-zapier-simulator/pipeline`
|
||||
|
||||
**Package:** `verae-zapier-simulator`
|
||||
**Source:** `packages/verae-zapier-simulator/src/pipeline.js`
|
||||
**Lines:** 883
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-simulator`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`ACTIONS`, `Simulator`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `Simulator` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `redact` | `obj` | — | `unknown` | see Call graph |
|
||||
| `sleep` | `ms` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `(none)` |
|
||||
| `reset` | `(none)` |
|
||||
| `snapshot` | `(none)` |
|
||||
| `run` | `req` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
- `../../verae-request-splitter/src/splitRequest.js`
|
||||
- `../../verae-archive-worm/src/archive.js`
|
||||
- `../../verae-archive-aggregator/src/aggregate.js`
|
||||
- `../../verae-tree-node/src/merkle.js`
|
||||
- `./trace.js`
|
||||
- `./monitors.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`setTimeout`, `up`, `app`, `constructor`, `reset`, `snapshot`, `map`, `keys`, `values`, `run`, `emit`, `redact`, `perform`, `signup`, `finish`, `connect`, `edgeAuth`, `meter`, `timestamp`, `lookup`, `batch`, `verify`, `assign`, `analyze`, `randomUUID`, `replace`, `slice`, `push`, `authentication`, `at`, `find`, `splitRequest`, `archivePuts`, `get`, `net`, `maybeDelay`, `seal`, `toISOString`, `queryArchives`, `mergeReceipts`, `filter`, `sha256Hex`, `toLowerCase`, `test`, `verifyProof`, `isArray`, `split`, `trim`, `buildMerkle`, `shardIndex`, `merkleProof`, `put`, `endsWith`, `query`, `includes`, `aggregateAttached`, `set`, `now`, `sleep`
|
||||
|
||||
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`.
|
||||
|
||||
45
docs/modules/verae-zapier-simulator/server.md
Normal file
45
docs/modules/verae-zapier-simulator/server.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# `verae-zapier-simulator/server`
|
||||
|
||||
**Package:** `verae-zapier-simulator`
|
||||
**Source:** `packages/verae-zapier-simulator/src/server.js`
|
||||
**Lines:** 87
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-simulator`. 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) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `send` | `res, code, body, type = 'application/json; charset=utf-8'` | — | `unknown` | see Call graph |
|
||||
| `readBody` | `req` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./pipeline.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`dirname`, `fileURLToPath`, `join`, `send`, `stringify`, `writeHead`, `end`, `readBody`, `on`, `push`, `concat`, `toString`, `resolve`, `parse`, `reject`, `createServer`, `async`, `snapshot`, `reset`, `run`, `normalize`, `startsWith`, `existsSync`, `statSync`, `isDirectory`, `extname`, `createReadStream`, `pipe`, `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`.
|
||||
|
||||
48
docs/modules/verae-zapier-simulator/trace.md
Normal file
48
docs/modules/verae-zapier-simulator/trace.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
# `verae-zapier-simulator/trace`
|
||||
|
||||
**Package:** `verae-zapier-simulator`
|
||||
**Source:** `packages/verae-zapier-simulator/src/trace.js`
|
||||
**Lines:** 45
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-simulator`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`TraceBus`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `TraceBus` |
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `(none)` |
|
||||
| `now` | `(none)` |
|
||||
| `emit` | `e` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`constructor`, `now`, `emit`, `push`
|
||||
|
||||
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`.
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier`
|
||||
**Source:** `packages/verae-zapier/index.js`
|
||||
**Lines:** 81
|
||||
**Lines:** 83
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -33,6 +33,7 @@ _None extracted._
|
|||
- `./creates/add_numbers`
|
||||
- `./searches/job_status`
|
||||
- `./searches/hash_lookup`
|
||||
- `./searches/tree_lookup`
|
||||
- `./triggers/timestamp_completed`
|
||||
- `zapier-platform-core`
|
||||
- `./package.json`
|
||||
|
|
|
|||
41
docs/modules/verae-zapier/searches/tree_lookup.md
Normal file
41
docs/modules/verae-zapier/searches/tree_lookup.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# `verae-zapier/searches/tree_lookup`
|
||||
|
||||
**Package:** `verae-zapier`
|
||||
**Source:** `packages/verae-zapier/searches/tree_lookup.js`
|
||||
**Lines:** 46
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`key`, `noun`, `display`, `label`, `description`, `chain`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `base` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `perform` | `z, bundle` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`async`, `encodeURIComponent`, `request`, `base`, `repeat`
|
||||
|
||||
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`.
|
||||
|
||||
|
|
@ -1,13 +1,44 @@
|
|||
# Sphinx config for Verae × Zapier module reference.
|
||||
# Sphinx config for Verae × Zapier (HTML + LaTeX).
|
||||
project = "Verae Time × Zapier"
|
||||
author = "Verae"
|
||||
release = "0.1.0"
|
||||
extensions = []
|
||||
extensions = ["myst_parser"]
|
||||
myst_enable_extensions = ["colon_fence", "deflist", "tasklist"]
|
||||
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
|
||||
templates_path = ["_templates"]
|
||||
exclude_patterns = ["_build"]
|
||||
html_theme = "alabaster"
|
||||
html_static_path = []
|
||||
html_theme_options = {
|
||||
"description": "Public module reference",
|
||||
"fixed_sidebar": True,
|
||||
}
|
||||
master_doc = "index"
|
||||
latex_engine = "pdflatex"
|
||||
latex_elements = {
|
||||
"papersize": "letterpaper",
|
||||
"pointsize": "10pt",
|
||||
"preamble": r"\usepackage{xcolor}\usepackage{booktabs}",
|
||||
}
|
||||
latex_documents = [
|
||||
(master_doc, "verae-zapier-modules.tex", "Verae Time × Zapier Module Reference", author, "manual"),
|
||||
(
|
||||
"latex-index",
|
||||
"verae-zapier-modules.tex",
|
||||
"Verae Time × Zapier Repository READMEs",
|
||||
author,
|
||||
"manual",
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
def _drop_svg_images(app, doctree, fromdocname):
|
||||
from docutils import nodes
|
||||
|
||||
for node in list(doctree.findall(nodes.image)):
|
||||
uri = node.get("uri") or ""
|
||||
if uri.endswith(".svg"):
|
||||
node.replace_self(nodes.paragraph(text=f"[SVG diagram {uri} — see HTML catalog]"))
|
||||
|
||||
|
||||
def setup(app):
|
||||
app.connect("doctree-resolved", _drop_svg_images)
|
||||
|
|
|
|||
|
|
@ -1,9 +1,33 @@
|
|||
Verae × Zapier module reference
|
||||
=================================
|
||||
|
||||
Public HTML: https://zapier.georgelambert.org/sphinx/
|
||||
LaTeX/PDF: https://zapier.georgelambert.org/sphinx/verae-zapier-modules.pdf
|
||||
Markdown indexes: https://zapier.georgelambert.org/index-md.html
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Repository READMEs
|
||||
|
||||
repos/overview
|
||||
repos/verae-ops
|
||||
repos/zappier
|
||||
repos/verae-zapier-middleware
|
||||
repos/verae-zapier
|
||||
repos/verae-activate
|
||||
repos/verae-request-splitter
|
||||
repos/verae-archive-worm
|
||||
repos/verae-archive-aggregator
|
||||
repos/verae-tree-node
|
||||
repos/verae-fleet
|
||||
repos/verae-zapier-simulator
|
||||
repos/zapier-user-docs
|
||||
repos/docs-master
|
||||
repos/verae-nats-process
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Modules
|
||||
:caption: API modules
|
||||
|
||||
modules/zappier/accounts
|
||||
modules/zappier/admin-users
|
||||
|
|
@ -88,4 +112,29 @@ Verae × Zapier module reference
|
|||
modules/verae-zapier/index
|
||||
modules/verae-zapier/searches/hash_lookup
|
||||
modules/verae-zapier/searches/job_status
|
||||
modules/verae-zapier/searches/tree_lookup
|
||||
modules/verae-zapier/triggers/timestamp_completed
|
||||
modules/verae-fleet/agent
|
||||
modules/verae-fleet/classify
|
||||
modules/verae-fleet/cli
|
||||
modules/verae-fleet/health
|
||||
modules/verae-fleet/load
|
||||
modules/verae-fleet/machines
|
||||
modules/verae-fleet/monitor
|
||||
modules/verae-fleet/rtt
|
||||
modules/verae-fleet/server
|
||||
modules/verae-fleet/ssh
|
||||
modules/verae-fleet/supervisor
|
||||
modules/verae-fleet/worker
|
||||
modules/verae-tree-node/merkle
|
||||
modules/verae-archive-worm/archive
|
||||
modules/verae-archive-worm/bloom
|
||||
modules/verae-archive-aggregator/aggregate
|
||||
modules/verae-request-splitter/splitRequest
|
||||
modules/verae-nats-process/handle
|
||||
modules/verae-nats-process/subjects
|
||||
modules/verae-nats-process/worker
|
||||
modules/verae-zapier-simulator/monitors
|
||||
modules/verae-zapier-simulator/pipeline
|
||||
modules/verae-zapier-simulator/server
|
||||
modules/verae-zapier-simulator/trace
|
||||
|
|
|
|||
25
docs/sphinx/latex-index.rst
Normal file
25
docs/sphinx/latex-index.rst
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
Verae Time × Zapier — repository READMEs
|
||||
==========================================
|
||||
|
||||
LaTeX/PDF companion to the Sphinx HTML API sheets.
|
||||
Public: https://zapier.georgelambert.org/sphinx/verae-zapier-modules.pdf
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Repository READMEs
|
||||
|
||||
repos/overview
|
||||
repos/verae-ops
|
||||
repos/zappier
|
||||
repos/verae-zapier-middleware
|
||||
repos/verae-zapier
|
||||
repos/verae-activate
|
||||
repos/verae-request-splitter
|
||||
repos/verae-archive-worm
|
||||
repos/verae-archive-aggregator
|
||||
repos/verae-tree-node
|
||||
repos/verae-fleet
|
||||
repos/verae-zapier-simulator
|
||||
repos/zapier-user-docs
|
||||
repos/docs-master
|
||||
repos/verae-nats-process
|
||||
|
|
@ -4,4 +4,4 @@ verae-activate.authentication
|
|||
Generated API sheet for ``verae-activate/authentication``.
|
||||
|
||||
.. include:: authentication.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-activate.creates.add_numbers
|
|||
Generated API sheet for ``verae-activate/creates/add_numbers``.
|
||||
|
||||
.. include:: add_numbers.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-activate.creates.echo
|
|||
Generated API sheet for ``verae-activate/creates/echo``.
|
||||
|
||||
.. include:: echo.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-activate.creates.sha256
|
|||
Generated API sheet for ``verae-activate/creates/sha256``.
|
||||
|
||||
.. include:: sha256.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-activate.creates.timestamp
|
|||
Generated API sheet for ``verae-activate/creates/timestamp``.
|
||||
|
||||
.. include:: timestamp.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-activate.index
|
|||
Generated API sheet for ``verae-activate/index``.
|
||||
|
||||
.. include:: index.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
41
docs/sphinx/modules/verae-archive-aggregator/aggregate.md
Normal file
41
docs/sphinx/modules/verae-archive-aggregator/aggregate.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# `verae-archive-aggregator/aggregate`
|
||||
|
||||
**Package:** `verae-archive-aggregator`
|
||||
**Source:** `packages/verae-archive-aggregator/src/aggregate.js`
|
||||
**Lines:** 67
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-archive-aggregator`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`aggregateAttached`, `mergeReceipts`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `aggregateAttached` | `{ sha256, tenantId, kinds = ['publicMeta', 'privateMeta', 'file'], archives }` | opts: `object`, opts.sha256: `string`, opts.tenantId: `string`, opts.kinds: `string[]`, opts.timeoutMs: `number` | `{ archivesQueried: boolean, archiveReplies: number, records: object[], silent: string[] ` — } | see Call graph |
|
||||
| `mergeReceipts` | `chainReceipts, archiveRecords` | chainReceipts: `object[]`, archiveRecords: `object[]` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`mock`, `aggregateAttached`, `query`, `push`, `includes`, `mergeReceipts`, `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`.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
verae-archive-aggregator.aggregate
|
||||
==================================
|
||||
|
||||
Generated API sheet for ``verae-archive-aggregator/aggregate``.
|
||||
|
||||
.. include:: aggregate.md
|
||||
:parser: myst_parser.sphinx_
|
||||
48
docs/sphinx/modules/verae-archive-worm/archive.md
Normal file
48
docs/sphinx/modules/verae-archive-worm/archive.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
# `verae-archive-worm/archive`
|
||||
|
||||
**Package:** `verae-archive-worm`
|
||||
**Source:** `packages/verae-archive-worm/src/archive.js`
|
||||
**Lines:** 41
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-archive-worm`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`WormArchive`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `WormArchive` |
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `archiveId` |
|
||||
| `put` | `put` |
|
||||
| `query` | `sha256` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./bloom.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`constructor`, `put`, `toLowerCase`, `get`, `push`, `toISOString`, `set`, `add`, `null`, `records`, `query`, `mightHave`
|
||||
|
||||
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/verae-archive-worm/archive.rst
Normal file
7
docs/sphinx/modules/verae-archive-worm/archive.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-archive-worm.archive
|
||||
==========================
|
||||
|
||||
Generated API sheet for ``verae-archive-worm/archive``.
|
||||
|
||||
.. include:: archive.md
|
||||
:parser: myst_parser.sphinx_
|
||||
49
docs/sphinx/modules/verae-archive-worm/bloom.md
Normal file
49
docs/sphinx/modules/verae-archive-worm/bloom.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# `verae-archive-worm/bloom`
|
||||
|
||||
**Package:** `verae-archive-worm`
|
||||
**Source:** `packages/verae-archive-worm/src/bloom.js`
|
||||
**Lines:** 47
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-archive-worm`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`Bloom`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `Bloom` |
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `m = 16384, k = 4` |
|
||||
| `hashes` | `s` |
|
||||
| `add` | `s` |
|
||||
| `mightHave` | `s` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`membership`, `constructor`, `alloc`, `ceil`, `hashes`, `createHash`, `update`, `digest`, `readUInt32BE`, `push`, `add`, `maybe`, `mightHave`, `every`
|
||||
|
||||
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/verae-archive-worm/bloom.rst
Normal file
7
docs/sphinx/modules/verae-archive-worm/bloom.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-archive-worm.bloom
|
||||
========================
|
||||
|
||||
Generated API sheet for ``verae-archive-worm/bloom``.
|
||||
|
||||
.. include:: bloom.md
|
||||
:parser: myst_parser.sphinx_
|
||||
51
docs/sphinx/modules/verae-fleet/agent.md
Normal file
51
docs/sphinx/modules/verae-fleet/agent.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# `verae-fleet/agent`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/agent.js`
|
||||
**Lines:** 87
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startAgent`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `json` | `res, code, obj` | — | `unknown` | see Call graph |
|
||||
| `readBody` | `req` | — | `unknown` | see Call graph |
|
||||
| `startAgent` | `{ port = PORT, bind = BIND } = {}` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `startAgent` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:child_process`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `dirname`, `fileURLToPath`, `json`, `writeHead`, `end`, `stringify`, `readBody`, `push`, `concat`, `toString`, `parse`, `startAgent`, `createServer`, `async`, `keys`, `has`, `get`, `spawn`, `set`, `on`, `delete`, `kill`, `listen`, `write`, `close`, `values`, `clear`, `basename`
|
||||
|
||||
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/verae-fleet/agent.rst
Normal file
7
docs/sphinx/modules/verae-fleet/agent.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.agent
|
||||
=================
|
||||
|
||||
Generated API sheet for ``verae-fleet/agent``.
|
||||
|
||||
.. include:: agent.md
|
||||
:parser: myst_parser.sphinx_
|
||||
40
docs/sphinx/modules/verae-fleet/classify.md
Normal file
40
docs/sphinx/modules/verae-fleet/classify.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# `verae-fleet/classify`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/classify.js`
|
||||
**Lines:** 30
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`classifyService`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `classifyService` | `sv` | — | `'operational'|'degraded'|'down'` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`classifyService`, `filter`
|
||||
|
||||
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/verae-fleet/classify.rst
Normal file
7
docs/sphinx/modules/verae-fleet/classify.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.classify
|
||||
====================
|
||||
|
||||
Generated API sheet for ``verae-fleet/classify``.
|
||||
|
||||
.. include:: classify.md
|
||||
:parser: myst_parser.sphinx_
|
||||
62
docs/sphinx/modules/verae-fleet/cli.md
Normal file
62
docs/sphinx/modules/verae-fleet/cli.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
# `verae-fleet/cli`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/cli.js`
|
||||
**Lines:** 146
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. 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) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `print` | `obj` | — | `unknown` | see Call graph |
|
||||
| `help` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `api` | `method, pathname` | — | `unknown` | see Call graph |
|
||||
| `main` | `(none)` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `print` | ``verae-fleet
|
||||
|
||||
list services, config files, replica min/max
|
||||
serve start floors + monitor + UI ${BASE}/
|
||||
monitor same without printing extra
|
||||
status GET daemon status
|
||||
start <service> turn on, spawn up to min
|
||||
stop <service|instance> turn off (service disable` |
|
||||
| `print` | `r.body` |
|
||||
| `print` | `{ error: err.message, hint: 'Is `verae-fleet serve` running?' }` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `./load.js`
|
||||
- `./supervisor.js`
|
||||
- `./monitor.js`
|
||||
- `./server.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`loadFleet`, `slice`, `print`, `write`, `stringify`, `help`, `off`, `pause`, `json`, `identityFile`, `login`, `api`, `request`, `on`, `push`, `concat`, `toString`, `resolve`, `parse`, `end`, `main`, `listServices`, `padEnd`, `padStart`, `import`, `find`, `sshCheck`, `keys`, `startService`, `tick`, `start`, `startControlServer`, `async`, `stop`, `stopAll`, `exit`, `test`
|
||||
|
||||
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/verae-fleet/cli.rst
Normal file
7
docs/sphinx/modules/verae-fleet/cli.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.cli
|
||||
===============
|
||||
|
||||
Generated API sheet for ``verae-fleet/cli``.
|
||||
|
||||
.. include:: cli.md
|
||||
:parser: myst_parser.sphinx_
|
||||
47
docs/sphinx/modules/verae-fleet/health.md
Normal file
47
docs/sphinx/modules/verae-fleet/health.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# `verae-fleet/health`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/health.js`
|
||||
**Lines:** 119
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`httpProbe`, `tcpProbe`, `postControl`, `heartbeatFresh`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `httpProbe` | `portOrOpts, pathname = '/health', timeoutMs = 800` | — | `unknown` | see Call graph |
|
||||
| `tcpProbe` | `host, port, timeoutMs = 400` | — | `unknown` | see Call graph |
|
||||
| `postControl` | `portOrOpts, pathname = '/'` | pathname: `string` | `unknown` | see Call graph |
|
||||
| `heartbeatFresh` | `stateDir, maxAgeMs` | — | `unknown` | see Call graph |
|
||||
| `done` | `ok, error` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:net`
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`httpProbe`, `get`, `on`, `push`, `parse`, `concat`, `toString`, `resolve`, `destroy`, `tcpProbe`, `connect`, `setTimeout`, `done`, `postControl`, `stringify`, `request`, `byteLength`, `write`, `end`, `heartbeatFresh`, `join`, `statSync`, `readFileSync`, `now`
|
||||
|
||||
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/verae-fleet/health.rst
Normal file
7
docs/sphinx/modules/verae-fleet/health.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.health
|
||||
==================
|
||||
|
||||
Generated API sheet for ``verae-fleet/health``.
|
||||
|
||||
.. include:: health.md
|
||||
:parser: myst_parser.sphinx_
|
||||
45
docs/sphinx/modules/verae-fleet/load.md
Normal file
45
docs/sphinx/modules/verae-fleet/load.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# `verae-fleet/load`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/load.js`
|
||||
**Lines:** 95
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`FLEET_ROOT`, `readJson`, `loadFleet`, `listServices`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `readJson` | `file` | — | `unknown` | see Call graph |
|
||||
| `loadFleet` | `root = FLEET_ROOT, opts = {}` | root: `string` | `unknown` | see Call graph |
|
||||
| `listServices` | `loaded` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./machines.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`dirname`, `fileURLToPath`, `resolve`, `readJson`, `parse`, `readFileSync`, `loadFleet`, `join`, `readdirSync`, `sort`, `endsWith`, `push`, `loadMachines`, `relative`, `listServices`, `values`, `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`.
|
||||
|
||||
7
docs/sphinx/modules/verae-fleet/load.rst
Normal file
7
docs/sphinx/modules/verae-fleet/load.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.load
|
||||
================
|
||||
|
||||
Generated API sheet for ``verae-fleet/load``.
|
||||
|
||||
.. include:: load.md
|
||||
:parser: myst_parser.sphinx_
|
||||
47
docs/sphinx/modules/verae-fleet/machines.md
Normal file
47
docs/sphinx/modules/verae-fleet/machines.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# `verae-fleet/machines`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/machines.js`
|
||||
**Lines:** 108
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`defaultMachines`, `loadMachines`, `normalizeMachine`, `upsertMachine`, `canHost`, `pickMachine`, `saveOverlay`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `defaultMachines` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `loadMachines` | `root, overlayPath` | — | `unknown` | see Call graph |
|
||||
| `normalizeMachine` | `m` | — | `unknown` | see Call graph |
|
||||
| `upsertMachine` | `list, spec` | — | `unknown` | see Call graph |
|
||||
| `canHost` | `machine, serviceId, role` | — | `unknown` | see Call graph |
|
||||
| `pickMachine` | `machines, instances, serviceId, role, exclude = []` | machines: `object[]`, serviceId: `string`, role: `string` | `unknown` | see Call graph |
|
||||
| `saveOverlay` | `overlayPath, machines` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`defaultMachines`, `plane`, `loadMachines`, `join`, `existsSync`, `parse`, `readFileSync`, `isArray`, `upsertMachine`, `assign`, `map`, `normalizeMachine`, `trim`, `findIndex`, `push`, `canHost`, `includes`, `capacity`, `pickMachine`, `filter`, `has`, `sort`, `localeCompare`, `find`, `saveOverlay`, `mkdirSync`, `dirname`, `writeFileSync`, `stringify`
|
||||
|
||||
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/verae-fleet/machines.rst
Normal file
7
docs/sphinx/modules/verae-fleet/machines.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.machines
|
||||
====================
|
||||
|
||||
Generated API sheet for ``verae-fleet/machines``.
|
||||
|
||||
.. include:: machines.md
|
||||
:parser: myst_parser.sphinx_
|
||||
49
docs/sphinx/modules/verae-fleet/monitor.md
Normal file
49
docs/sphinx/modules/verae-fleet/monitor.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# `verae-fleet/monitor`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/monitor.js`
|
||||
**Lines:** 39
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`Monitor`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `Monitor` |
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `supervisor, opts = {}` |
|
||||
| `tick` | `(none)` |
|
||||
| `start` | `(none)` |
|
||||
| `stop` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`floors`, `import`, `constructor`, `tick`, `reconcile`, `toISOString`, `status`, `start`, `setInterval`, `log`, `stop`, `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`.
|
||||
|
||||
7
docs/sphinx/modules/verae-fleet/monitor.rst
Normal file
7
docs/sphinx/modules/verae-fleet/monitor.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.monitor
|
||||
===================
|
||||
|
||||
Generated API sheet for ``verae-fleet/monitor``.
|
||||
|
||||
.. include:: monitor.md
|
||||
:parser: myst_parser.sphinx_
|
||||
52
docs/sphinx/modules/verae-fleet/rtt.md
Normal file
52
docs/sphinx/modules/verae-fleet/rtt.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
# `verae-fleet/rtt`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/rtt.js`
|
||||
**Lines:** 58
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`RttWindow`, `summarizeRtt`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `RttWindow` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `summarizeRtt` | `samples` | samples: `number[]` | `unknown` | see Call graph |
|
||||
| `percentile` | `sorted, p` | — | `unknown` | see Call graph |
|
||||
| `round1` | `n` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `cap = 400` |
|
||||
| `add` | `ms` |
|
||||
| `stats` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`constructor`, `add`, `isFinite`, `push`, `splice`, `stats`, `summarizeRtt`, `filter`, `slice`, `sort`, `reduce`, `round1`, `percentile`, `floor`, `ceil`, `round`
|
||||
|
||||
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/verae-fleet/rtt.rst
Normal file
7
docs/sphinx/modules/verae-fleet/rtt.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.rtt
|
||||
===============
|
||||
|
||||
Generated API sheet for ``verae-fleet/rtt``.
|
||||
|
||||
.. include:: rtt.md
|
||||
:parser: myst_parser.sphinx_
|
||||
46
docs/sphinx/modules/verae-fleet/server.md
Normal file
46
docs/sphinx/modules/verae-fleet/server.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# `verae-fleet/server`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/server.js`
|
||||
**Lines:** 146
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startControlServer`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `json` | `res, code, obj` | — | `unknown` | see Call graph |
|
||||
| `startControlServer` | `sup, mon` | sup: `import('./supervisor.js').Supervisor`, mon: `import('./monitor.js').Monitor` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./load.js`
|
||||
- `../../verae-zapier-simulator/src/pipeline.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `dirname`, `fileURLToPath`, `json`, `writeHead`, `end`, `stringify`, `import`, `startControlServer`, `createServer`, `async`, `snapshot`, `reset`, `push`, `parse`, `concat`, `toString`, `run`, `listServices`, `status`, `addMachine`, `match`, `checkMachine`, `setMachineEnabled`, `reconcile`, `startService`, `stopService`, `pauseService`, `resumeService`, `fn`, `pauseInstance`, `resumeInstance`, `restartInstance`, `stopInstance`, `markUnhealthy`, `createReadStream`, `pipe`, `startsWith`, `normalize`, `existsSync`, `statSync`, `isFile`, `extname`, `toLowerCase`, `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/verae-fleet/server.rst
Normal file
7
docs/sphinx/modules/verae-fleet/server.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.server
|
||||
==================
|
||||
|
||||
Generated API sheet for ``verae-fleet/server``.
|
||||
|
||||
.. include:: server.md
|
||||
:parser: myst_parser.sphinx_
|
||||
55
docs/sphinx/modules/verae-fleet/ssh.md
Normal file
55
docs/sphinx/modules/verae-fleet/ssh.md
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
# `verae-fleet/ssh`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/ssh.js`
|
||||
**Lines:** 171
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`expandHome`, `shellQuote`, `sshTarget`, `sshBaseArgs`, `scpBaseArgs`, `sshExec`, `scpTo`, `ensureRemoteRuntime`, `sshSpawnWorker`, `sshKillWorker`, `sshHttp`, `sshCheck`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `expandHome` | `p` | — | `unknown` | see Call graph |
|
||||
| `shellQuote` | `s` | — | `unknown` | see Call graph |
|
||||
| `sshTarget` | `machine` | — | `unknown` | see Call graph |
|
||||
| `sshBaseArgs` | `machine` | — | `unknown` | see Call graph |
|
||||
| `scpBaseArgs` | `machine` | — | `unknown` | see Call graph |
|
||||
| `sshExec` | `machine, remoteCommand, { timeoutMs = 20000 } = {}` | — | `unknown` | see Call graph |
|
||||
| `scpTo` | `machine, localFiles, remoteDir` | — | `unknown` | see Call graph |
|
||||
| `ensureRemoteRuntime` | `machine` | — | `unknown` | see Call graph |
|
||||
| `sshSpawnWorker` | `machine, { instance, env }` | — | `unknown` | see Call graph |
|
||||
| `sshKillWorker` | `machine, pid, instance` | — | `unknown` | see Call graph |
|
||||
| `sshHttp` | `machine, method, urlPath, { port, body } = {}` | — | `unknown` | see Call graph |
|
||||
| `sshCheck` | `machine` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:child_process`
|
||||
- `node:fs`
|
||||
- `node:os`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`dirname`, `fileURLToPath`, `expandHome`, `homedir`, `startsWith`, `join`, `slice`, `shellQuote`, `replace`, `sshTarget`, `sshBaseArgs`, `existsSync`, `push`, `scpBaseArgs`, `sshExec`, `spawn`, `on`, `setTimeout`, `kill`, `reject`, `clearTimeout`, `concat`, `toString`, `trim`, `resolve`, `scpTo`, `ensureRemoteRuntime`, `has`, `add`, `sshSpawnWorker`, `entries`, `filter`, `map`, `split`, `pop`, `isFinite`, `sshKillWorker`, `sshHttp`, `stringify`, `parse`, `sshCheck`
|
||||
|
||||
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/verae-fleet/ssh.rst
Normal file
7
docs/sphinx/modules/verae-fleet/ssh.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.ssh
|
||||
===============
|
||||
|
||||
Generated API sheet for ``verae-fleet/ssh``.
|
||||
|
||||
.. include:: ssh.md
|
||||
:parser: myst_parser.sphinx_
|
||||
82
docs/sphinx/modules/verae-fleet/supervisor.md
Normal file
82
docs/sphinx/modules/verae-fleet/supervisor.md
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
# `verae-fleet/supervisor`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/supervisor.js`
|
||||
**Lines:** 511
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`Supervisor`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `Supervisor` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `waitExit` | `child, ms` | — | `unknown` | see Call graph |
|
||||
| `waitForHealth` | `rec, ms` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `opts = {}` |
|
||||
| `machines` | `(none)` |
|
||||
| `addMachine` | `spec` |
|
||||
| `setMachineEnabled` | `id, enabled` |
|
||||
| `checkMachine` | `id` |
|
||||
| `machineOf` | `rec` |
|
||||
| `controlInstance` | `rec, pathname, body` |
|
||||
| `log` | `type, detail` |
|
||||
| `spec` | `serviceId` |
|
||||
| `nextIndex` | `serviceId` |
|
||||
| `startOne` | `serviceId, opts = {}` |
|
||||
| `stopInstance` | `instanceId, { replace = true } = {}` |
|
||||
| `pauseInstance` | `instanceId, { replace = true } = {}` |
|
||||
| `resumeInstance` | `instanceId` |
|
||||
| `restartInstance` | `instanceId` |
|
||||
| `markUnhealthy` | `instanceId` |
|
||||
| `probe` | `rec` |
|
||||
| `available` | `serviceId` |
|
||||
| `reconcile` | `only` |
|
||||
| `startService` | `serviceId` |
|
||||
| `stopService` | `serviceId, { holdFloor = false } = {}` |
|
||||
| `pauseService` | `serviceId` |
|
||||
| `resumeService` | `serviceId` |
|
||||
| `stopAll` | `(none)` |
|
||||
| `status` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:child_process`
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./load.js`
|
||||
- `./health.js`
|
||||
- `./classify.js`
|
||||
- `./machines.js`
|
||||
- `./rtt.js`
|
||||
- `./ssh.js`
|
||||
|
||||
## 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`
|
||||
|
||||
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/verae-fleet/supervisor.rst
Normal file
7
docs/sphinx/modules/verae-fleet/supervisor.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.supervisor
|
||||
======================
|
||||
|
||||
Generated API sheet for ``verae-fleet/supervisor``.
|
||||
|
||||
.. include:: supervisor.md
|
||||
:parser: myst_parser.sphinx_
|
||||
57
docs/sphinx/modules/verae-fleet/worker.md
Normal file
57
docs/sphinx/modules/verae-fleet/worker.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
# `verae-fleet/worker`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/worker.js`
|
||||
**Lines:** 154
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. 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) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `processMessage` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `snapshot` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `beat` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `shutdown` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `json` | `code, obj` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `json` | `404, { error: 'not found' }` |
|
||||
| `beat` | `(none)` |
|
||||
| `clearInterval` | `iv` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `node:crypto`
|
||||
- `node:url`
|
||||
- `./rtt.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `cwd`, `toISOString`, `mkdirSync`, `resolve`, `dirname`, `fileURLToPath`, `import`, `put`, `query`, `processMessage`, `bigint`, `randomBytes`, `createHash`, `update`, `digest`, `add`, `snapshot`, `stats`, `beat`, `now`, `writeFileSync`, `stringify`, `createServer`, `writeHead`, `end`, `json`, `slice`, `listen`, `write`, `setInterval`, `max`, `round`, `shutdown`, `clearInterval`, `close`, `exit`, `on`
|
||||
|
||||
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/verae-fleet/worker.rst
Normal file
7
docs/sphinx/modules/verae-fleet/worker.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.worker
|
||||
==================
|
||||
|
||||
Generated API sheet for ``verae-fleet/worker``.
|
||||
|
||||
.. include:: worker.md
|
||||
:parser: myst_parser.sphinx_
|
||||
40
docs/sphinx/modules/verae-nats-process/handle.md
Normal file
40
docs/sphinx/modules/verae-nats-process/handle.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# `verae-nats-process/handle`
|
||||
|
||||
**Package:** `verae-nats-process`
|
||||
**Source:** `packages/verae-nats-process/src/handle.js`
|
||||
**Lines:** 21
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-nats-process`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`handle`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `handle` | `msg = {}` | msg: `object` | `Promise<object>|object` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`handle`, `toISOString`
|
||||
|
||||
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/verae-nats-process/handle.rst
Normal file
7
docs/sphinx/modules/verae-nats-process/handle.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-nats-process.handle
|
||||
=========================
|
||||
|
||||
Generated API sheet for ``verae-nats-process/handle``.
|
||||
|
||||
.. include:: handle.md
|
||||
:parser: myst_parser.sphinx_
|
||||
38
docs/sphinx/modules/verae-nats-process/subjects.md
Normal file
38
docs/sphinx/modules/verae-nats-process/subjects.md
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
# `verae-nats-process/subjects`
|
||||
|
||||
**Package:** `verae-nats-process`
|
||||
**Source:** `packages/verae-nats-process/src/subjects.js`
|
||||
**Lines:** 14
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-nats-process`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`AREA`, `RESOURCE`, `SUBJECTS`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`freeze`
|
||||
|
||||
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/verae-nats-process/subjects.rst
Normal file
7
docs/sphinx/modules/verae-nats-process/subjects.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-nats-process.subjects
|
||||
===========================
|
||||
|
||||
Generated API sheet for ``verae-nats-process/subjects``.
|
||||
|
||||
.. include:: subjects.md
|
||||
:parser: myst_parser.sphinx_
|
||||
49
docs/sphinx/modules/verae-nats-process/worker.md
Normal file
49
docs/sphinx/modules/verae-nats-process/worker.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# `verae-nats-process/worker`
|
||||
|
||||
**Package:** `verae-nats-process`
|
||||
**Source:** `packages/verae-nats-process/src/worker.js`
|
||||
**Lines:** 71
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-nats-process`. 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) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `snapshot` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `json` | `code, obj` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `json` | `404, { error: 'not found' }` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `./subjects.js`
|
||||
- `./handle.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`snapshot`, `createServer`, `async`, `writeHead`, `end`, `stringify`, `json`, `push`, `parse`, `concat`, `toString`, `handle`, `reply`, `listen`, `write`, `on`, `close`, `exit`
|
||||
|
||||
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/verae-nats-process/worker.rst
Normal file
7
docs/sphinx/modules/verae-nats-process/worker.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-nats-process.worker
|
||||
=========================
|
||||
|
||||
Generated API sheet for ``verae-nats-process/worker``.
|
||||
|
||||
.. include:: worker.md
|
||||
:parser: myst_parser.sphinx_
|
||||
42
docs/sphinx/modules/verae-request-splitter/splitRequest.md
Normal file
42
docs/sphinx/modules/verae-request-splitter/splitRequest.md
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# `verae-request-splitter/splitRequest`
|
||||
|
||||
**Package:** `verae-request-splitter`
|
||||
**Source:** `packages/verae-request-splitter/src/splitRequest.js`
|
||||
**Lines:** 72
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-request-splitter`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`sha256Hex`, `splitRequest`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `sha256Hex` | `data` | data: `string` | `string` | see Call graph |
|
||||
| `splitRequest` | `body = {}` | body: `object` | `{
|
||||
* chain: { sha256: string, hashAlg: string, data?: string ` — , | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`sha256Hex`, `createHash`, `update`, `digest`, `splitRequest`, `toLowerCase`, `keys`, `push`, `isArray`, `from`, `toString`
|
||||
|
||||
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 @@
|
|||
verae-request-splitter.splitRequest
|
||||
===================================
|
||||
|
||||
Generated API sheet for ``verae-request-splitter/splitRequest``.
|
||||
|
||||
.. include:: splitRequest.md
|
||||
:parser: myst_parser.sphinx_
|
||||
45
docs/sphinx/modules/verae-tree-node/merkle.md
Normal file
45
docs/sphinx/modules/verae-tree-node/merkle.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# `verae-tree-node/merkle`
|
||||
|
||||
**Package:** `verae-tree-node`
|
||||
**Source:** `packages/verae-tree-node/src/merkle.js`
|
||||
**Lines:** 97
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-tree-node`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`sha256Hex`, `parentHash`, `buildMerkle`, `merkleProof`, `verifyProof`, `shardIndex`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `sha256Hex` | `data` | data: `string|Buffer|Uint8Array` | `string` — lowercase hex | see Call graph |
|
||||
| `parentHash` | `left, right` | left: `string`, right: `string` | `unknown` | see Call graph |
|
||||
| `buildMerkle` | `leaves` | leaves: `string[]` | `{ root: string, layers: string[][], leaves: string[] ` — } | see Call graph |
|
||||
| `merkleProof` | `layers, index` | layers: `string[][]`, index: `number` | `Array<{ sibling: string, position: 'left'|'right' ` — >} | see Call graph |
|
||||
| `verifyProof` | `leaf, proof, root` | leaf: `string`, root: `string` | `unknown` | see Call graph |
|
||||
| `shardIndex` | `sha256, n` | sha256: `string`, n: `number` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`sha256Hex`, `isBuffer`, `from`, `createHash`, `update`, `digest`, `children`, `duplicated`, `parentHash`, `buildMerkle`, `map`, `toLowerCase`, `push`, `merkleProof`, `floor`, `verifyProof`, `nodes`, `shardIndex`, `slice`, `readUInt32BE`
|
||||
|
||||
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/verae-tree-node/merkle.rst
Normal file
7
docs/sphinx/modules/verae-tree-node/merkle.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-tree-node.merkle
|
||||
======================
|
||||
|
||||
Generated API sheet for ``verae-tree-node/merkle``.
|
||||
|
||||
.. include:: merkle.md
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.app
|
|||
Generated API sheet for ``verae-zapier-middleware/app``.
|
||||
|
||||
.. include:: app.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.clients.veraeClient
|
|||
Generated API sheet for ``verae-zapier-middleware/clients/veraeClient``.
|
||||
|
||||
.. include:: veraeClient.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.config
|
|||
Generated API sheet for ``verae-zapier-middleware/config``.
|
||||
|
||||
.. include:: config.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.config
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/config``.
|
||||
|
||||
.. include:: config.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.index
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/index``.
|
||||
|
||||
.. include:: index.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.logger
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/logger``.
|
||||
|
||||
.. include:: logger.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.redact
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/redact``.
|
||||
|
||||
.. include:: redact.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.trace-context
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/trace-context``.
|
||||
|
||||
.. include:: trace-context.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.trace
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/trace``.
|
||||
|
||||
.. include:: trace.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.errors
|
|||
Generated API sheet for ``verae-zapier-middleware/errors``.
|
||||
|
||||
.. include:: errors.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.index
|
|||
Generated API sheet for ``verae-zapier-middleware/index``.
|
||||
|
||||
.. include:: index.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.lib.receiptPdf
|
|||
Generated API sheet for ``verae-zapier-middleware/lib/receiptPdf``.
|
||||
|
||||
.. include:: receiptPdf.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.lib.tokens
|
|||
Generated API sheet for ``verae-zapier-middleware/lib/tokens``.
|
||||
|
||||
.. include:: tokens.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.middleware.authenticate
|
|||
Generated API sheet for ``verae-zapier-middleware/middleware/authenticate``.
|
||||
|
||||
.. include:: authenticate.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.middleware.rateLimit
|
|||
Generated API sheet for ``verae-zapier-middleware/middleware/rateLimit``.
|
||||
|
||||
.. include:: rateLimit.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.nats.connection
|
|||
Generated API sheet for ``verae-zapier-middleware/nats/connection``.
|
||||
|
||||
.. include:: connection.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.nats.publishers
|
|||
Generated API sheet for ``verae-zapier-middleware/nats/publishers``.
|
||||
|
||||
.. include:: publishers.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/nats/subjects.js`
|
||||
**Lines:** 44
|
||||
**Lines:** 48
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -26,7 +26,7 @@ _No imports detected._
|
|||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`freeze`, `names`
|
||||
`freeze`, `node`, `names`
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.nats.subjects
|
|||
Generated API sheet for ``verae-zapier-middleware/nats/subjects``.
|
||||
|
||||
.. include:: subjects.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.nats.wait
|
|||
Generated API sheet for ``verae-zapier-middleware/nats/wait``.
|
||||
|
||||
.. include:: wait.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue