master-zapier-plan-draft/docs/sphinx/modules/verae-zapier-middleware/clients/veraeClient.md
George Lambert 345aeeead9
Some checks are pending
offline / test (push) Waiting to run
Bind each customer to a Verae userId for hop tracing
Signup registers/binds a Verae central user and stores veraeUserId. Public access stays the zappier API key. Chain JWTs stay server-side behind tokenRef. Authz, billing, and jobs.watch carry veraeUserId.
2026-09-11 16:18:06 -04:00

3.3 KiB
Raw Blame History

verae-zapier-middleware/clients/veraeClient

Package: verae-zapier-middleware
Source: packages/verae-zapier-middleware/src/clients/veraeClient.js
Lines: 386

What this module is

Implementation module in verae-zapier-middleware. The tables below are extracted from the source (signatures + JSDoc).

Exports

sha256Hex, veraeClient, clearMockJobs

Types / interfaces / classes

None extracted.

Functions

Name Parameters Param types (JSDoc) Returns Calls (same file / helpers)
sha256Hex data data: string string see Call graph
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
mockCreateUser { username, password, role = 'user' } unknown see Call graph
mockCreateTimestamp { data, hashAlg, sha256, publicMetadata, privateMetadata } unknown see Call graph
mockGetStatus jobId unknown see Call graph
mockLookupHash sha256 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
createUser adminToken, body
bindUser credentials
createTimestamp token, body
lookupHash token, sha256
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
  • ../lib/identity.js

Call graph (identifiers invoked)

net, createDebugger, sha256Hex, createHash, update, digest, delay, setTimeout, mockLogin, now, toISOString, stableVeraeUserId, includes, mockValidate, startsWith, replace, mockCreateUser, mockCreateTimestamp, toLowerCase, get, randomUUID, set, mockGetStatus, mockLookupHash, mockVerify, request, debug, fetch, stringify, text, parse, error, client, login, validate, createUser, bindUser, createTimestamp, lookupHash, 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 modules 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.