George Lambert 10c663cc0c 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.

2026-09-09 02:44:51 -04:00

3 KiB

Raw Blame History

`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.

3 KiB Raw Blame History Unescape Escape

verae-zapier-middleware/services/timestampService