Milestone 2: module/model docs (MD, Sphinx RST, PDF) and work log
74 source modules documented with extracted signatures, JSDoc params, imports, and call graphs. 10 first-class models (PriceRule through StatusResponse) have their own MD/RST/PDF. Sphinx HTML builds from docs/sphinx. Per-module PDFs in docs/modules-pdf and docs/models-pdf. Middleware gates 2–6 and 10 pass on MOCK_VERAE without NATS. Learned: RST includes are relative to the RST file; keep one PDF per module; Add Numbers remains the only push required tomorrow.
This commit is contained in:
parent
b814501441
commit
10c663cc0c
347 changed files with 17200 additions and 14 deletions
45
docs/modules/verae-zapier-middleware/app.md
Normal file
45
docs/modules/verae-zapier-middleware/app.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# `verae-zapier-middleware/app`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/app.js`
|
||||
**Lines:** 51
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`createApp`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `createApp` | `options = {}` | — | `import('express').Express` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `express`
|
||||
- `./errors.js`
|
||||
- `./debug/logger.js`
|
||||
- `./debug/trace.js`
|
||||
- `./routes/index.js`
|
||||
- `./store/db.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `app`, `import`, `createApp`, `loadStore`, `express`, `disable`, `use`, `json`, `get`, `sendError`, `info`
|
||||
|
||||
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`.
|
||||
|
||||
66
docs/modules/verae-zapier-middleware/clients/veraeClient.md
Normal file
66
docs/modules/verae-zapier-middleware/clients/veraeClient.md
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
# `verae-zapier-middleware/clients/veraeClient`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/clients/veraeClient.js`
|
||||
**Lines:** 288
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`veraeClient`, `clearMockJobs`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `delay` | `ms` | ms: `number` | `Promise<void>` | see Call graph |
|
||||
| `mockLogin` | `{ username, password }` | ms: `number` | `Promise<void>` | see Call graph |
|
||||
| `mockValidate` | `token` | — | `unknown` | see Call graph |
|
||||
| `mockCreateTimestamp` | `{ data, hashAlg }` | — | `unknown` | see Call graph |
|
||||
| `mockGetStatus` | `jobId` | — | `unknown` | see Call graph |
|
||||
| `mockVerify` | `{ certificate }` | — | `unknown` | see Call graph |
|
||||
| `request` | `path, { method = 'GET', token, body } = {}` | path: `string` | `Promise<any>` | see Call graph |
|
||||
| `clearMockJobs` | `(none)` | — | `void` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `setTimeout` | `(` |
|
||||
| `login` | `credentials` |
|
||||
| `validate` | `token` |
|
||||
| `createTimestamp` | `token, body` |
|
||||
| `createBatchTimestamp` | `token, body` |
|
||||
| `getStatus` | `token, jobId` |
|
||||
| `getBatchStatus` | `token, body` |
|
||||
| `verify` | `token, body` |
|
||||
| `verifyBatch` | `token, body` |
|
||||
| `getJobVerification` | `token, jobId` |
|
||||
| `waitForJob` | `token, jobId, { maxAttempts, intervalMs }` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
- `../config.js`
|
||||
- `../errors.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`net`, `createDebugger`, `delay`, `setTimeout`, `mockLogin`, `now`, `toISOString`, `randomUUID`, `includes`, `mockValidate`, `startsWith`, `replace`, `mockCreateTimestamp`, `set`, `get`, `mockGetStatus`, `mockVerify`, `request`, `debug`, `fetch`, `stringify`, `text`, `parse`, `error`, `client`, `login`, `validate`, `createTimestamp`, `createBatchTimestamp`, `push`, `getStatus`, `encodeURIComponent`, `getBatchStatus`, `verify`, `verifyBatch`, `getJobVerification`, `waitForJob`, `jobs`, `clearMockJobs`, `clear`
|
||||
|
||||
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-middleware/config.md
Normal file
45
docs/modules/verae-zapier-middleware/config.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# `verae-zapier-middleware/config`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/config.js`
|
||||
**Lines:** 143
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`loadEnvFile`, `config`, `PLAN_LIMITS`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `loadEnvFile` | `(none)` | — | `void` | see Call graph |
|
||||
| `bool` | `value, fallback = false` | value: `string|undefined`, fallback: `boolean` | `boolean` | see Call graph |
|
||||
| `int` | `value, fallback` | value: `string|undefined`, fallback: `number` | `number` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
- `./debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `dirname`, `fileURLToPath`, `resolve`, `loadEnvFile`, `existsSync`, `readFileSync`, `split`, `trim`, `startsWith`, `indexOf`, `slice`, `bool`, `includes`, `toLowerCase`, `int`, `parseInt`, `isFinite`, `replace`, `info`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
43
docs/modules/verae-zapier-middleware/debug/config.md
Normal file
43
docs/modules/verae-zapier-middleware/debug/config.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# `verae-zapier-middleware/debug/config`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/config.js`
|
||||
**Lines:** 107
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`parseDebugVeraeEnv`, `parseLevel`, `loadDebugConfig`, `shouldLog`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `parseDebugVeraeEnv` | `raw` | raw: `string|undefined` | `{ enabled: boolean, namespaces: Set<string>|null ` — } | see Call graph |
|
||||
| `parseLevel` | `raw, fallback = 'debug'` | raw: `string|undefined`, fallback: `'debug'|'info'|'warn'|'error'` | `'debug'|'info'|'warn'|'error'` | see Call graph |
|
||||
| `loadDebugConfig` | `env = process.env` | env: `NodeJS.ProcessEnv` | `DebugConfig` | see Call graph |
|
||||
| `shouldLog` | `config, namespace, messageLevel` | config: `DebugConfig`, namespace: `string`, messageLevel: `'debug'|'info'|'warn'|'error'` | `boolean` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`value`, `parseDebugVeraeEnv`, `trim`, `toLowerCase`, `split`, `map`, `filter`, `parseLevel`, `namespaces`, `loadDebugConfig`, `namespace`, `shouldLog`, `has`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
39
docs/modules/verae-zapier-middleware/debug/index.md
Normal file
39
docs/modules/verae-zapier-middleware/debug/index.md
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
# `verae-zapier-middleware/debug/index`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/index.js`
|
||||
**Lines:** 25
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
_No named `export` / `module.exports` keys detected._
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./config.js`
|
||||
- `./logger.js`
|
||||
- `./redact.js`
|
||||
- `./trace.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
_No local call identifiers extracted._
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
47
docs/modules/verae-zapier-middleware/debug/logger.md
Normal file
47
docs/modules/verae-zapier-middleware/debug/logger.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# `verae-zapier-middleware/debug/logger`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/logger.js`
|
||||
**Lines:** 122
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`setDebugTestSink`, `formatLogLine`, `createDebugger`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `setDebugTestSink` | `sink` | sink: `null|((line: string) => void)` | `void` | see Call graph |
|
||||
| `formatLogLine` | `{ level, namespace, message, meta, traceId }` | parts: `object`, parts.level: `string`, parts.namespace: `string`, parts.message: `string`, parts.meta: `Record<string, unknown>|undefined`, parts.traceId: `string|null` | `string` | see Call graph |
|
||||
| `emit` | `line, filePath` | line: `string`, filePath: `string|null` | `void` | see Call graph |
|
||||
| `createDebugger` | `namespace` | namespace: `string` | `Debugger` — Logger with debug/info/warn/error methods. | see Call graph |
|
||||
| `write` | `level, message, meta` | level: `'debug'|'info'|'warn'|'error'`, message: `string`, meta: `Record<string, unknown>` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `./config.js`
|
||||
- `./redact.js`
|
||||
- `./trace-context.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`setDebugTestSink`, `formatLogLine`, `toISOString`, `keys`, `stringify`, `redact`, `toUpperCase`, `emit`, `testSink`, `error`, `appendFileSync`, `createDebugger`, `debug`, `toLowerCase`, `write`, `loadDebugConfig`, `shouldLog`, `getTraceId`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
41
docs/modules/verae-zapier-middleware/debug/redact.md
Normal file
41
docs/modules/verae-zapier-middleware/debug/redact.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# `verae-zapier-middleware/debug/redact`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/redact.js`
|
||||
**Lines:** 94
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`redactString`, `redact`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `redactString` | `value` | value: `string` | `string` — Original or `[REDACTED]`. | see Call graph |
|
||||
| `redact` | `input, depth = 0` | input: `unknown`, depth: `number` | `unknown` — Redacted structure safe for logging. | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`redactString`, `test`, `redact`, `isArray`, `map`, `entries`, `has`, `toLowerCase`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
43
docs/modules/verae-zapier-middleware/debug/trace-context.md
Normal file
43
docs/modules/verae-zapier-middleware/debug/trace-context.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# `verae-zapier-middleware/debug/trace-context`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/trace-context.js`
|
||||
**Lines:** 40
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`traceStorage`, `generateTraceId`, `getTraceId`, `getTraceContext`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `generateTraceId` | `(none)` | — | `string` | see Call graph |
|
||||
| `getTraceId` | `(none)` | — | `string|null` | see Call graph |
|
||||
| `getTraceContext` | `(none)` | — | `TraceContext|null` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:async_hooks`
|
||||
- `node:crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`context`, `id`, `generateTraceId`, `randomBytes`, `toString`, `getTraceId`, `getStore`, `getTraceContext`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
48
docs/modules/verae-zapier-middleware/debug/trace.md
Normal file
48
docs/modules/verae-zapier-middleware/debug/trace.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
# `verae-zapier-middleware/debug/trace`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/debug/trace.js`
|
||||
**Lines:** 96
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`withTrace`, `traceMiddleware`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `withTrace` | `options, fn` | options: `object|(() => T|Promise<T>)`, options.traceId: `string`, options.span: `string`, fn: `() => T|Promise<T>` | `T|Promise<T>` — Return value of `fn`. | see Call graph |
|
||||
| `traceMiddleware` | `req, res, next` | req: `import('express').Request`, res: `import('express').Response`, next: `import('express').NextFunction` | `void` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `withTrace` | `{ traceId, span: `${req.method} ${req.path}` }, (` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./logger.js`
|
||||
- `./trace-context.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `id`, `span`, `withTrace`, `async`, `getTraceId`, `getStore`, `generateTraceId`, `run`, `debug`, `callback`, `then`, `import`, `traceMiddleware`, `trim`, `setHeader`, `next`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
51
docs/modules/verae-zapier-middleware/errors.md
Normal file
51
docs/modules/verae-zapier-middleware/errors.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# `verae-zapier-middleware/errors`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/errors.js`
|
||||
**Lines:** 76
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`AppError`, `asyncHandler`, `sendError`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `AppError` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `asyncHandler` | `fn` | fn: `(req: import('express').Request, res: import('express').Response, next: import('express').NextFunction) => Promise<unknown>` | `import('express').RequestHandler` | see Call graph |
|
||||
| `sendError` | `res, err` | res: `import('express').Response`, err: `Error|AppError` | `void` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `message, { status = 500, code = 'INTERNAL_ERROR', details } = {}` |
|
||||
| `return` | `req, res, next` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./debug/logger.js`
|
||||
- `./debug/trace-context.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `details`, `constructor`, `import`, `asyncHandler`, `resolve`, `fn`, `sendError`, `getTraceId`, `error`, `debug`, `status`, `json`
|
||||
|
||||
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-zapier-middleware/index.md
Normal file
52
docs/modules/verae-zapier-middleware/index.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
# `verae-zapier-middleware/index`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/index.js`
|
||||
**Lines:** 52
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startServer`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `startServer` | `(none)` | — | `import('http').Server` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `startServer` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./app.js`
|
||||
- `./config.js`
|
||||
- `./debug/logger.js`
|
||||
- `./workers/inProcessJobPoller.js`
|
||||
- `./nats/connection.js`
|
||||
- `./workers/jobPollerWorker.js`
|
||||
- `./workers/webhookWorker.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `import`, `startServer`, `createApp`, `connectNats`, `then`, `ensureStreams`, `all`, `startJobPollerWorker`, `startWebhookWorker`, `info`, `error`, `startInProcessJobPoller`, `listen`, `log`, `includes`
|
||||
|
||||
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-zapier-middleware/lib/tokens.md
Normal file
46
docs/modules/verae-zapier-middleware/lib/tokens.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# `verae-zapier-middleware/lib/tokens`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/lib/tokens.js`
|
||||
**Lines:** 98
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`issueSessionToken`, `parseSessionToken`, `generateApiKey`, `isApiKey`, `extractBearerToken`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `sign` | `payload` | payload: `string` | `string` | see Call graph |
|
||||
| `issueSessionToken` | `{ tenantId, veraeToken, expiresAt }` | params: `object`, params.tenantId: `string`, params.veraeToken: `string`, params.expiresAt: `string` | `string` — Token string starting with `zmt_` | see Call graph |
|
||||
| `parseSessionToken` | `token` | token: `string` | `{ tenantId: string, veraeToken: string, expiresAt?: string, nonce?: string ` — |null} | see Call graph |
|
||||
| `generateApiKey` | `(none)` | — | `string` | see Call graph |
|
||||
| `isApiKey` | `value` | value: `unknown` | `boolean` | see Call graph |
|
||||
| `extractBearerToken` | `header` | header: `string|undefined` | `string|null` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
- `../config.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`sign`, `createHmac`, `update`, `digest`, `issueSessionToken`, `from`, `stringify`, `randomBytes`, `toString`, `parseSessionToken`, `startsWith`, `slice`, `lastIndexOf`, `timingSafeEqual`, `parse`, `key`, `generateApiKey`, `isApiKey`, `extractBearerToken`, `match`
|
||||
|
||||
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,47 @@
|
|||
# `verae-zapier-middleware/middleware/authenticate`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/middleware/authenticate.js`
|
||||
**Lines:** 28
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`authenticate`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `next` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../lib/tokens.js`
|
||||
- `../services/authService.js`
|
||||
- `../errors.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `asyncHandler`, `async`, `extractBearerToken`, `resolveAuthContext`, `debug`, `next`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
48
docs/modules/verae-zapier-middleware/middleware/rateLimit.md
Normal file
48
docs/modules/verae-zapier-middleware/middleware/rateLimit.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
# `verae-zapier-middleware/middleware/rateLimit`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/middleware/rateLimit.js`
|
||||
**Lines:** 57
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`resetRateLimitWindows`, `rateLimit`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `resetRateLimitWindows` | `(none)` | — | `void` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `next` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../errors.js`
|
||||
- `../store/tenants.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `windows`, `resetRateLimitWindows`, `clear`, `asyncHandler`, `async`, `next`, `getTenant`, `resolveLimits`, `now`, `get`, `set`, `debug`
|
||||
|
||||
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-zapier-middleware/nats/connection.md
Normal file
46
docs/modules/verae-zapier-middleware/nats/connection.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# `verae-zapier-middleware/nats/connection`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/nats/connection.js`
|
||||
**Lines:** 112
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`connectNats`, `ensureStreams`, `closeNats`, `getJetStream`, `isNatsConnected`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `connectNats` | `url = config.natsUrl` | url: `string` | `Promise<{ nc: import('nats').NatsConnection, js: import('nats').JetStreamClient, jsm: import('nats').JetStreamManager ` — >} | see Call graph |
|
||||
| `ensureStreams` | `manager` | manager: `import('nats').JetStreamManager` | `Promise<void>` | see Call graph |
|
||||
| `closeNats` | `(none)` | — | `Promise<void>` | see Call graph |
|
||||
| `getJetStream` | `(none)` | — | `import('nats').JetStreamClient|null` | see Call graph |
|
||||
| `isNatsConnected` | `(none)` | — | `boolean` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../debug/logger.js`
|
||||
- `../config.js`
|
||||
- `./subjects.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `import`, `connectNats`, `debug`, `disabled`, `info`, `connect`, `jetstream`, `jetstreamManager`, `ensureStreams`, `add`, `closeNats`, `drain`, `getJetStream`, `isNatsConnected`, `isClosed`
|
||||
|
||||
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-zapier-middleware/nats/publishers.md
Normal file
46
docs/modules/verae-zapier-middleware/nats/publishers.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# `verae-zapier-middleware/nats/publishers`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/nats/publishers.js`
|
||||
**Lines:** 96
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`enqueueWatch`, `publishJobEvent`, `enqueueWebhook`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `requireJs` | `(none)` | — | `Promise<import('nats').JetStreamClient>` | see Call graph |
|
||||
| `enqueueWatch` | `partial` | partial: `object` | `Promise<{ seq: number ` — >} | see Call graph |
|
||||
| `publishJobEvent` | `partial` | partial: `object` | `Promise<{ seq: number ` — >} | see Call graph |
|
||||
| `enqueueWebhook` | `partial` | partial: `object` | `Promise<{ seq: number ` — >} | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../debug/logger.js`
|
||||
- `../debug/trace-context.js`
|
||||
- `./subjects.js`
|
||||
- `./connection.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `import`, `requireJs`, `getJetStream`, `connectNats`, `enqueueWatch`, `toISOString`, `getTraceId`, `debug`, `publish`, `stringify`, `publishJobEvent`, `enqueueWebhook`
|
||||
|
||||
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-zapier-middleware/nats/subjects.md
Normal file
38
docs/modules/verae-zapier-middleware/nats/subjects.md
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
# `verae-zapier-middleware/nats/subjects`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/nats/subjects.js`
|
||||
**Lines:** 44
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`SUBJECTS`, `STREAMS`, `CONSUMERS`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`freeze`, `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.
|
||||
|
||||
## 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`.
|
||||
|
||||
50
docs/modules/verae-zapier-middleware/routes/authRoutes.md
Normal file
50
docs/modules/verae-zapier-middleware/routes/authRoutes.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
# `verae-zapier-middleware/routes/authRoutes`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/routes/authRoutes.js`
|
||||
**Lines:** 58
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`authRoutes`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `express`
|
||||
- `../errors.js`
|
||||
- `../services/authService.js`
|
||||
- `../store/usage.js`
|
||||
- `../store/tenants.js`
|
||||
- `../lib/tokens.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`post`, `asyncHandler`, `async`, `loginWithApiKey`, `json`, `loginWithCredentials`, `get`, `extractBearerToken`, `validateSession`, `getTenant`, `getUsageSummary`
|
||||
|
||||
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-zapier-middleware/routes/index.md
Normal file
46
docs/modules/verae-zapier-middleware/routes/index.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# `verae-zapier-middleware/routes/index`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/routes/index.js`
|
||||
**Lines:** 34
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`apiRoutes`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `express`
|
||||
- `./authRoutes.js`
|
||||
- `./timestampRoutes.js`
|
||||
- `./verifyRoutes.js`
|
||||
- `./statusRoutes.js`
|
||||
- `./webhookRoutes.js`
|
||||
- `./tenantRoutes.js`
|
||||
- `../middleware/authenticate.js`
|
||||
- `../middleware/rateLimit.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`use`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
48
docs/modules/verae-zapier-middleware/routes/statusRoutes.md
Normal file
48
docs/modules/verae-zapier-middleware/routes/statusRoutes.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
# `verae-zapier-middleware/routes/statusRoutes`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/routes/statusRoutes.js`
|
||||
**Lines:** 47
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`statusRoutes`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `express`
|
||||
- `../errors.js`
|
||||
- `../services/timestampService.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`post`, `asyncHandler`, `async`, `isArray`, `getBatchJobStatus`, `json`, `get`, `getJobVerification`, `getJobStatus`
|
||||
|
||||
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`.
|
||||
|
||||
50
docs/modules/verae-zapier-middleware/routes/tenantRoutes.md
Normal file
50
docs/modules/verae-zapier-middleware/routes/tenantRoutes.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
# `verae-zapier-middleware/routes/tenantRoutes`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/routes/tenantRoutes.js`
|
||||
**Lines:** 47
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`publicTenantRoutes`, `adminTenantRoutes`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
| `next` | `(none)` |
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
| `asyncHandler` | `async (_req, res` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `express`
|
||||
- `../errors.js`
|
||||
- `../services/tenantService.js`
|
||||
- `../config.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`post`, `asyncHandler`, `async`, `selfServeSignup`, `status`, `json`, `use`, `next`, `provisionTenant`, `get`, `listProvisionedTenants`
|
||||
|
||||
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,48 @@
|
|||
# `verae-zapier-middleware/routes/timestampRoutes`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/routes/timestampRoutes.js`
|
||||
**Lines:** 50
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`timestampRoutes`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `express`
|
||||
- `../errors.js`
|
||||
- `../services/timestampService.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`post`, `asyncHandler`, `async`, `createTimestamp`, `status`, `json`, `createTimestampAndWait`, `isArray`, `createBatchTimestamp`
|
||||
|
||||
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-zapier-middleware/routes/verifyRoutes.md
Normal file
47
docs/modules/verae-zapier-middleware/routes/verifyRoutes.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# `verae-zapier-middleware/routes/verifyRoutes`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/routes/verifyRoutes.js`
|
||||
**Lines:** 37
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`verifyRoutes`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `express`
|
||||
- `../errors.js`
|
||||
- `../services/verifyService.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`post`, `asyncHandler`, `async`, `verifyTimestamp`, `json`, `isArray`, `verifyBatch`
|
||||
|
||||
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-zapier-middleware/routes/webhookRoutes.md
Normal file
49
docs/modules/verae-zapier-middleware/routes/webhookRoutes.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# `verae-zapier-middleware/routes/webhookRoutes`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/routes/webhookRoutes.js`
|
||||
**Lines:** 45
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`webhookRoutes`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
| `asyncHandler` | `async (req, res` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `express`
|
||||
- `../errors.js`
|
||||
- `../services/webhookService.js`
|
||||
- `../store/webhooks.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`post`, `asyncHandler`, `async`, `subscribe`, `status`, `json`, `delete`, `unsubscribe`, `get`, `listWebhooksForTenant`
|
||||
|
||||
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-zapier-middleware/services/authService.md
Normal file
47
docs/modules/verae-zapier-middleware/services/authService.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# `verae-zapier-middleware/services/authService`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/authService.js`
|
||||
**Lines:** 142
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`loginWithCredentials`, `loginWithApiKey`, `resolveAuthContext`, `validateSession`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `loginWithCredentials` | `{ username, password, tenant }` | params: `object`, params.username: `string`, params.password: `string`, params.tenant: `object` | `Promise<{ accessToken: string, expiresAt: string, tenant: object, user: object ` — >} | see Call graph |
|
||||
| `loginWithApiKey` | `apiKey` | apiKey: `string` | `Promise<Awaited<ReturnType<typeof loginWithCredentials>>>` | see Call graph |
|
||||
| `resolveAuthContext` | `rawToken` | rawToken: `string|null` | `Promise<{ tenantId: string, tenant: object, veraeToken: string, authMethod: string ` — >} | see Call graph |
|
||||
| `validateSession` | `rawToken` | rawToken: `string` | `Promise<object>` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../clients/veraeClient.js`
|
||||
- `../store/tenants.js`
|
||||
- `../lib/tokens.js`
|
||||
- `../errors.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `loginWithCredentials`, `debug`, `login`, `issueSessionToken`, `loginWithApiKey`, `getTenantByApiKey`, `resolveAuthContext`, `isApiKey`, `parseSessionToken`, `getTenant`, `parse`, `now`, `validateSession`, `validate`
|
||||
|
||||
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,47 @@
|
|||
# `verae-zapier-middleware/services/entitlementService`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/entitlementService.js`
|
||||
**Lines:** 161
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`checkEntitlement`, `recordUsage`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `isUnlimited` | `value` | — | `unknown` | see Call graph |
|
||||
| `quotaExceeded` | `{ limit, used, allowOverage }` | — | `unknown` | see Call graph |
|
||||
| `checkEntitlement` | `tenantId, action, { amount = 1 } = {}` | tenantId: `string`, action: `'timestamp'|'verify'|'batch_timestamp'` | `{ tenant: object, limits: object, usage: object ` — } | see Call graph |
|
||||
| `recordUsage` | `tenantId, action, { amount = 1 } = {}` | tenantId: `string`, action: `string` | `void` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../config.js`
|
||||
- `../errors.js`
|
||||
- `../store/tenants.js`
|
||||
- `../store/usage.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `isUnlimited`, `quotaExceeded`, `checkEntitlement`, `getTenant`, `resolveLimits`, `getUsage`, `debug`, `recordUsage`, `incrementUsage`
|
||||
|
||||
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,57 @@
|
|||
# `verae-zapier-middleware/services/tenantService`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/tenantService.js`
|
||||
**Lines:** 138
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`selfServeSignup`, `provisionTenant`, `listProvisionedTenants`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `slugify` | `value` | — | `unknown` | see Call graph |
|
||||
| `validateVeraeCredentials` | `username, password` | — | `unknown` | see Call graph |
|
||||
| `selfServeSignup` | `{ email, name, veraeUsername, veraePassword }` | — | `unknown` | see Call graph |
|
||||
| `provisionTenant` | `{
|
||||
id,
|
||||
name,
|
||||
plan,
|
||||
veraeUsername,
|
||||
veraePassword,
|
||||
contract = null,
|
||||
metadata = {},
|
||||
audience = 'admin',
|
||||
}` | — | `unknown` | see Call graph |
|
||||
| `listProvisionedTenants` | `(none)` | — | `Array<object>` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
- `../store/tenants.js`
|
||||
- `../clients/veraeClient.js`
|
||||
- `../errors.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `slugify`, `toLowerCase`, `replace`, `slice`, `validateVeraeCredentials`, `login`, `selfServeSignup`, `randomUUID`, `createTenant`, `info`, `provision`, `provisionTenant`, `has`, `getTenant`, `listProvisionedTenants`, `listTenants`, `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,70 @@
|
|||
# `verae-zapier-middleware/services/timestampService`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/timestampService.js`
|
||||
**Lines:** 123
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`createTimestamp`, `createTimestampAndWait`, `createBatchTimestamp`, `getJobStatus`, `getBatchJobStatus`, `getJobVerification`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `enqueueWatchForJob` | `ctx, jobId` | ctx: `object`, jobId: `string` | `unknown` | see Call graph |
|
||||
| `createTimestamp` | `ctx, body` | ctx: `object` | `Promise<{ jobId: string ` — >} | see Call graph |
|
||||
| `createTimestampAndWait` | `ctx, body` | ctx: `object` | `Promise<object>` — StatusResponse | see Call graph |
|
||||
| `createBatchTimestamp` | `ctx, body` | ctx: `object` | `unknown` | see Call graph |
|
||||
| `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 |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `enqueueJob` | `{
|
||||
tenantId: ctx.tenantId,
|
||||
jobId,
|
||||
veraeToken: ctx.veraeToken,
|
||||
traceId,
|
||||
}` |
|
||||
| `checkEntitlement` | `ctx.tenantId, 'timestamp'` |
|
||||
| `recordUsage` | `ctx.tenantId, 'timestamp'` |
|
||||
| `recordUsage` | `ctx.tenantId, 'status'` |
|
||||
| `checkEntitlement` | `ctx.tenantId, 'batch_timestamp', { amount: itemCount }` |
|
||||
| `recordUsage` | `ctx.tenantId, 'batch_timestamp', { amount: itemCount }` |
|
||||
| `recordUsage` | `ctx.tenantId, 'status'` |
|
||||
| `recordUsage` | `ctx.tenantId, 'status', { amount: body.jobIds?.length ?? 1 }` |
|
||||
| `recordUsage` | `ctx.tenantId, 'status'` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../config.js`
|
||||
- `../clients/veraeClient.js`
|
||||
- `../store/jobWatchers.js`
|
||||
- `./entitlementService.js`
|
||||
- `../debug/logger.js`
|
||||
- `../debug/trace-context.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `enqueueWatchForJob`, `getTraceId`, `import`, `enqueueWatch`, `debug`, `enqueueJob`, `createTimestamp`, `checkEntitlement`, `recordUsage`, `createTimestampAndWait`, `waitForJob`, `createBatchTimestamp`, `getJobStatus`, `getStatus`, `getBatchJobStatus`, `getBatchStatus`, `getJobVerification`
|
||||
|
||||
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,52 @@
|
|||
# `verae-zapier-middleware/services/verifyService`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/verifyService.js`
|
||||
**Lines:** 35
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`verifyTimestamp`, `verifyBatch`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `verifyTimestamp` | `ctx, body` | ctx: `object` | `unknown` | see Call graph |
|
||||
| `verifyBatch` | `ctx, body` | ctx: `object` | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `checkEntitlement` | `ctx.tenantId, 'verify'` |
|
||||
| `recordUsage` | `ctx.tenantId, 'verify'` |
|
||||
| `checkEntitlement` | `ctx.tenantId, 'verify', { amount }` |
|
||||
| `recordUsage` | `ctx.tenantId, 'verify', { amount }` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../clients/veraeClient.js`
|
||||
- `./entitlementService.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `verifyTimestamp`, `checkEntitlement`, `verify`, `recordUsage`, `debug`, `verifyBatch`
|
||||
|
||||
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,43 @@
|
|||
# `verae-zapier-middleware/services/webhookService`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/webhookService.js`
|
||||
**Lines:** 71
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`subscribe`, `unsubscribe`, `deliverWebhook`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `subscribe` | `ctx, { targetUrl, event }` | ctx: `object` | `unknown` | see Call graph |
|
||||
| `unsubscribe` | `ctx, { hookId, targetUrl }` | ctx: `object` | `unknown` | see Call graph |
|
||||
| `deliverWebhook` | `targetUrl, payload` | targetUrl: `string`, payload: `object` | `Promise<{ ok: boolean, status: number ` — >} | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../store/webhooks.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `subscribe`, `has`, `createWebhook`, `unsubscribe`, `deleteWebhook`, `deliverWebhook`, `debug`, `fetch`, `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`.
|
||||
|
||||
54
docs/modules/verae-zapier-middleware/store/db.md
Normal file
54
docs/modules/verae-zapier-middleware/store/db.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
# `verae-zapier-middleware/store/db`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/store/db.js`
|
||||
**Lines:** 115
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`emptyStore`, `loadStore`, `getStore`, `setStoreForTests`, `persist`, `reloadStore`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `emptyStore` | `(none)` | — | `StoreShape` | see Call graph |
|
||||
| `loadStore` | `path = config.storePath` | path: `string` | `StoreShape` | see Call graph |
|
||||
| `getStore` | `(none)` | — | `StoreShape` | see Call graph |
|
||||
| `setStoreForTests` | `next` | next: `StoreShape|null` | `void` | see Call graph |
|
||||
| `persist` | `path = config.storePath` | path: `string` | `void` | see Call graph |
|
||||
| `reloadStore` | `path = config.storePath` | path: `string` | `StoreShape` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `writeFileSync` | `path, JSON.stringify(data, null, 2` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:fs`
|
||||
- `node:path`
|
||||
- `../config.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`store`, `createDebugger`, `emptyStore`, `memory`, `loadStore`, `existsSync`, `readFileSync`, `parse`, `isArray`, `debug`, `keys`, `error`, `getStore`, `setStoreForTests`, `persist`, `dirname`, `mkdirSync`, `writeFileSync`, `stringify`, `disk`, `reloadStore`
|
||||
|
||||
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`.
|
||||
|
||||
53
docs/modules/verae-zapier-middleware/store/jobWatchers.md
Normal file
53
docs/modules/verae-zapier-middleware/store/jobWatchers.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# `verae-zapier-middleware/store/jobWatchers`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/store/jobWatchers.js`
|
||||
**Lines:** 90
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`enqueueJob`, `listPendingJobs`, `updateJobWatcher`, `removeJobWatcher`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `enqueueJob` | `{ tenantId, jobId, veraeToken, traceId }` | params: `object`, params.tenantId: `string`, params.jobId: `string`, params.veraeToken: `string`, params.traceId: `string` | `JobWatcher` | see Call graph |
|
||||
| `listPendingJobs` | `(none)` | — | `JobWatcher[]` | see Call graph |
|
||||
| `updateJobWatcher` | `id, patch` | id: `string`, patch: `Partial<JobWatcher>` | `JobWatcher|null` | see Call graph |
|
||||
| `removeJobWatcher` | `id` | id: `string` | `void` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `persist` | `(none)` |
|
||||
| `persist` | `(none)` |
|
||||
| `persist` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
- `./db.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`queue`, `createDebugger`, `enqueueJob`, `randomUUID`, `toISOString`, `getStore`, `push`, `persist`, `debug`, `listPendingJobs`, `filter`, `updateJobWatcher`, `findIndex`, `removeJobWatcher`
|
||||
|
||||
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`.
|
||||
|
||||
70
docs/modules/verae-zapier-middleware/store/tenants.md
Normal file
70
docs/modules/verae-zapier-middleware/store/tenants.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# `verae-zapier-middleware/store/tenants`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/store/tenants.js`
|
||||
**Lines:** 138
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`getTenant`, `getTenantByApiKey`, `listTenants`, `upsertTenant`, `createTenant`, `resolveLimits`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `getTenant` | `tenantId` | tenantId: `string` | `Tenant|null` | see Call graph |
|
||||
| `getTenantByApiKey` | `apiKey` | apiKey: `string` | `Tenant|null` | see Call graph |
|
||||
| `listTenants` | `(none)` | — | `Tenant[]` | see Call graph |
|
||||
| `upsertTenant` | `tenant` | tenant: `Tenant` | `Tenant` | see Call graph |
|
||||
| `createTenant` | `{
|
||||
id,
|
||||
name,
|
||||
plan = 'free',
|
||||
veraeUsername,
|
||||
veraePassword,
|
||||
contract = null,
|
||||
apiKey = generateApiKey(` | params: `object`, params.id: `string`, params.name: `string`, params.plan: `string`, params.veraeUsername: `string`, params.veraePassword: `string`, params.contract: `object|null`, params.apiKey: `string`, params.metadata: `object` | `{ tenant: Tenant, apiKey: string ` — } | see Call graph |
|
||||
| `resolveLimits` | `tenant` | tenant: `Tenant` | `{
|
||||
* timestamps: number|null,
|
||||
* verifications: number|null,
|
||||
* batch: boolean,
|
||||
* batchMaxItems: number|null,
|
||||
* requestsPerMinute: number,
|
||||
* allowOverage: boolean,
|
||||
* overageRates: object
|
||||
* ` — } | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `persist` | `(none)` |
|
||||
| `persist` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./db.js`
|
||||
- `../lib/tokens.js`
|
||||
- `../config.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `getTenant`, `getStore`, `getTenantByApiKey`, `listTenants`, `values`, `upsertTenant`, `persist`, `debug`, `createTenant`, `generateApiKey`, `toISOString`, `info`, `tenant`, `resolveLimits`
|
||||
|
||||
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`.
|
||||
|
||||
53
docs/modules/verae-zapier-middleware/store/usage.md
Normal file
53
docs/modules/verae-zapier-middleware/store/usage.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# `verae-zapier-middleware/store/usage`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/store/usage.js`
|
||||
**Lines:** 103
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`getUsage`, `getUsageSummary`, `incrementUsage`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `currentPeriod` | `(none)` | — | `string` — YYYY-MM period key | see Call graph |
|
||||
| `emptyUsage` | `tenantId` | tenantId: `string` | `{ period: string, timestamps: number, verifications: number, statusChecks: number, batchTimestamps: number, overage: object ` — } | see Call graph |
|
||||
| `getUsage` | `tenantId` | tenantId: `string` | `ReturnType<typeof emptyUsage>` | see Call graph |
|
||||
| `getUsageSummary` | `tenantId` | tenantId: `string` | `object` | see Call graph |
|
||||
| `incrementUsage` | `tenantId, metric, amount = 1` | tenantId: `string`, metric: `string`, amount: `number` | `void` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `getStore` | `(none)` |
|
||||
| `persist` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./db.js`
|
||||
- `./tenants.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `currentPeriod`, `getUTCFullYear`, `getUTCMonth`, `padStart`, `emptyUsage`, `getUsage`, `getStore`, `getUsageSummary`, `getTenant`, `resolveLimits`, `incrementUsage`, `startsWith`, `slice`, `persist`, `debug`
|
||||
|
||||
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-zapier-middleware/store/webhooks.md
Normal file
51
docs/modules/verae-zapier-middleware/store/webhooks.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# `verae-zapier-middleware/store/webhooks`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/store/webhooks.js`
|
||||
**Lines:** 92
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`createWebhook`, `deleteWebhook`, `getActiveWebhooks`, `listWebhooksForTenant`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `createWebhook` | `{ tenantId, targetUrl, event }` | params: `object`, params.tenantId: `string`, params.targetUrl: `string`, params.event: `string` | `Webhook` | see Call graph |
|
||||
| `deleteWebhook` | `{ tenantId, hookId, targetUrl }` | params: `object`, params.tenantId: `string`, params.hookId: `string`, params.targetUrl: `string` | `boolean` — True if at least one webhook was removed. | see Call graph |
|
||||
| `getActiveWebhooks` | `tenantId, event` | tenantId: `string`, event: `string` | `Webhook[]` | see Call graph |
|
||||
| `listWebhooksForTenant` | `tenantId` | tenantId: `string` | `Webhook[]` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `persist` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
- `./db.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `createWebhook`, `randomUUID`, `toISOString`, `getStore`, `push`, `persist`, `info`, `deleteWebhook`, `filter`, `getActiveWebhooks`, `listWebhooksForTenant`
|
||||
|
||||
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,57 @@
|
|||
# `verae-zapier-middleware/workers/inProcessJobPoller`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/workers/inProcessJobPoller.js`
|
||||
**Lines:** 109
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startInProcessJobPoller`, `stopInProcessJobPoller`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `processJob` | `job` | job: `import('../store/jobWatchers.js').JobWatcher` | `unknown` | see Call graph |
|
||||
| `tick` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `startInProcessJobPoller` | `(none)` | — | `void` | see Call graph |
|
||||
| `stopInProcessJobPoller` | `(none)` | — | `void` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `updateJobWatcher` | `job.id, { attempts }` |
|
||||
| `updateJobWatcher` | `job.id, { status: status.status }` |
|
||||
| `removeJobWatcher` | `job.id` |
|
||||
| `clearInterval` | `timer` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../config.js`
|
||||
- `../clients/veraeClient.js`
|
||||
- `../store/jobWatchers.js`
|
||||
- `../store/webhooks.js`
|
||||
- `../services/webhookService.js`
|
||||
- `../debug/logger.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `import`, `processJob`, `updateJobWatcher`, `removeJobWatcher`, `warn`, `getStatus`, `debug`, `getActiveWebhooks`, `deliverWebhook`, `error`, `tick`, `listPendingJobs`, `all`, `map`, `poller`, `startInProcessJobPoller`, `info`, `skipped`, `setInterval`, `stopInProcessJobPoller`, `clearInterval`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
# `verae-zapier-middleware/workers/jobPollerWorker`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/workers/jobPollerWorker.js`
|
||||
**Lines:** 159
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startJobPollerWorker`, `stopJobPollerWorker`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `resolveVeraeToken` | `msg` | msg: `object` | `Promise<string>` | see Call graph |
|
||||
| `handleWatch` | `data, ctrl` | data: `object` | `unknown` | see Call graph |
|
||||
| `startJobPollerWorker` | `(none)` | — | `Promise<{ stop: () => Promise<void> ` — >} | see Call graph |
|
||||
| `stopJobPollerWorker` | `(none)` | — | `Promise<void>` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../debug/logger.js`
|
||||
- `../config.js`
|
||||
- `../nats/subjects.js`
|
||||
- `../nats/connection.js`
|
||||
- `../nats/publishers.js`
|
||||
- `../clients/veraeClient.js`
|
||||
- `../store/tenants.js`
|
||||
- `../debug/trace.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `polling`, `resolveVeraeToken`, `getTenant`, `login`, `handleWatch`, `withTrace`, `async`, `publishJobEvent`, `ack`, `getStatus`, `debug`, `nak`, `startJobPollerWorker`, `stopJobPollerWorker`, `connectNats`, `ensureStreams`, `consumer`, `add`, `get`, `info`, `consume`, `parse`, `string`, `error`, `abort`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
# `verae-zapier-middleware/workers/webhookWorker`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/workers/webhookWorker.js`
|
||||
**Lines:** 139
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startWebhookWorker`, `stopWebhookWorker`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `handleDeliver` | `data, ctrl` | data: `object` | `unknown` | see Call graph |
|
||||
| `startWebhookWorker` | `(none)` | — | `Promise<{ stop: () => Promise<void> ` — >} | see Call graph |
|
||||
| `stopWebhookWorker` | `(none)` | — | `Promise<void>` | see Call graph |
|
||||
| `runConsumer` | `stream, durable` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `runConsumer` | `STREAMS.ZAPIER_EVENTS, CONSUMERS.EVENT_WEBHOOK_ROUTER` |
|
||||
| `runConsumer` | `STREAMS.ZAPIER_WEBHOOKS, CONSUMERS.WEBHOOK_DELIVER` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `../debug/logger.js`
|
||||
- `../nats/subjects.js`
|
||||
- `../nats/connection.js`
|
||||
- `../services/webhookService.js`
|
||||
- `../store/webhooks.js`
|
||||
- `../debug/trace.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `messages`, `handleDeliver`, `withTrace`, `async`, `getActiveWebhooks`, `deliverWebhook`, `ack`, `warn`, `keys`, `debug`, `nak`, `worker`, `startWebhookWorker`, `stopWebhookWorker`, `connectNats`, `ensureStreams`, `add`, `info`, `get`, `consume`, `parse`, `string`, `error`, `runConsumer`, `abort`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue