Bind each customer to a Verae userId for hop tracing
Some checks are pending
offline / test (push) Waiting to run
Some checks are pending
offline / test (push) Waiting to run
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.
This commit is contained in:
parent
1b199ca4d4
commit
345aeeead9
79 changed files with 703 additions and 95 deletions
|
|
@ -32,6 +32,7 @@ One MD file per source module.
|
|||
- [zappier/statement](zappier/statement.md)
|
||||
- [zappier/upstream](zappier/upstream.md)
|
||||
- [zappier/usage](zappier/usage.md)
|
||||
- [zappier/verae-bind](zappier/verae-bind.md)
|
||||
- [verae-zapier-middleware/app](verae-zapier-middleware/app.md)
|
||||
- [verae-zapier-middleware/clients/veraeClient](verae-zapier-middleware/clients/veraeClient.md)
|
||||
- [verae-zapier-middleware/config](verae-zapier-middleware/config.md)
|
||||
|
|
@ -43,6 +44,7 @@ One MD file per source module.
|
|||
- [verae-zapier-middleware/debug/trace](verae-zapier-middleware/debug/trace.md)
|
||||
- [verae-zapier-middleware/errors](verae-zapier-middleware/errors.md)
|
||||
- [verae-zapier-middleware/index](verae-zapier-middleware/index.md)
|
||||
- [verae-zapier-middleware/lib/identity](verae-zapier-middleware/lib/identity.md)
|
||||
- [verae-zapier-middleware/lib/receiptPdf](verae-zapier-middleware/lib/receiptPdf.md)
|
||||
- [verae-zapier-middleware/lib/tokens](verae-zapier-middleware/lib/tokens.md)
|
||||
- [verae-zapier-middleware/middleware/authenticate](verae-zapier-middleware/middleware/authenticate.md)
|
||||
|
|
@ -71,6 +73,7 @@ One MD file per source module.
|
|||
- [verae-zapier-middleware/store/db](verae-zapier-middleware/store/db.md)
|
||||
- [verae-zapier-middleware/store/jobWatchers](verae-zapier-middleware/store/jobWatchers.md)
|
||||
- [verae-zapier-middleware/store/tenants](verae-zapier-middleware/store/tenants.md)
|
||||
- [verae-zapier-middleware/store/tokenRefs](verae-zapier-middleware/store/tokenRefs.md)
|
||||
- [verae-zapier-middleware/store/usage](verae-zapier-middleware/store/usage.md)
|
||||
- [verae-zapier-middleware/store/webhooks](verae-zapier-middleware/store/webhooks.md)
|
||||
- [verae-zapier-middleware/workers/inProcessJobPoller](verae-zapier-middleware/workers/inProcessJobPoller.md)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-access-authz`
|
||||
**Source:** `packages/verae-access-authz/src/policy.js`
|
||||
**Lines:** 99
|
||||
**Lines:** 101
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/clients/veraeClient.js`
|
||||
**Lines:** 352
|
||||
**Lines:** 386
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -24,6 +24,7 @@ _None extracted._
|
|||
| `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 |
|
||||
|
|
@ -38,6 +39,8 @@ _None extracted._
|
|||
| `setTimeout` | `(` |
|
||||
| `login` | `credentials` |
|
||||
| `validate` | `token` |
|
||||
| `createUser` | `adminToken, body` |
|
||||
| `bindUser` | `credentials` |
|
||||
| `createTimestamp` | `token, body` |
|
||||
| `lookupHash` | `token, sha256` |
|
||||
| `createBatchTimestamp` | `token, body` |
|
||||
|
|
@ -54,10 +57,11 @@ _None extracted._
|
|||
- `../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`, `randomUUID`, `includes`, `mockValidate`, `startsWith`, `replace`, `mockCreateTimestamp`, `toLowerCase`, `get`, `set`, `mockGetStatus`, `mockLookupHash`, `mockVerify`, `request`, `debug`, `fetch`, `stringify`, `text`, `parse`, `error`, `client`, `login`, `validate`, `createTimestamp`, `lookupHash`, `createBatchTimestamp`, `push`, `getStatus`, `encodeURIComponent`, `getBatchStatus`, `verify`, `verifyBatch`, `getJobVerification`, `waitForJob`, `jobs`, `clearMockJobs`, `clear`
|
||||
`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 module’s MD for parameter and return types.
|
||||
|
||||
|
|
|
|||
41
docs/modules/verae-zapier-middleware/lib/identity.md
Normal file
41
docs/modules/verae-zapier-middleware/lib/identity.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# `verae-zapier-middleware/lib/identity`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/lib/identity.js`
|
||||
**Lines:** 17
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`normalizeVeraeUsername`, `stableVeraeUserId`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `normalizeVeraeUsername` | `username` | — | `unknown` | see Call graph |
|
||||
| `stableVeraeUserId` | `username` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`normalizeVeraeUsername`, `trim`, `toLowerCase`, `stableVeraeUserId`, `createHash`, `update`, `digest`, `slice`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/middleware/authenticate.js`
|
||||
**Lines:** 28
|
||||
**Lines:** 34
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -35,7 +35,7 @@ _No top-level functions extracted._
|
|||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `asyncHandler`, `async`, `extractBearerToken`, `resolveAuthContext`, `debug`, `next`
|
||||
`createDebugger`, `asyncHandler`, `async`, `extractBearerToken`, `resolveAuthContext`, `startsWith`, `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.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/nats/publishers.js`
|
||||
**Lines:** 96
|
||||
**Lines:** 98
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/authService.js`
|
||||
**Lines:** 142
|
||||
**Lines:** 154
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -35,7 +35,7 @@ _None extracted._
|
|||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `loginWithCredentials`, `debug`, `login`, `issueSessionToken`, `loginWithApiKey`, `getTenantByApiKey`, `resolveAuthContext`, `isApiKey`, `parseSessionToken`, `getTenant`, `parse`, `now`, `validateSession`, `validate`
|
||||
`createDebugger`, `loginWithCredentials`, `debug`, `login`, `upsertTenant`, `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.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/tenantService.js`
|
||||
**Lines:** 138
|
||||
**Lines:** 150
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -45,7 +45,7 @@ _None extracted._
|
|||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`createDebugger`, `slugify`, `toLowerCase`, `replace`, `slice`, `validateVeraeCredentials`, `login`, `selfServeSignup`, `randomUUID`, `createTenant`, `info`, `provision`, `provisionTenant`, `has`, `getTenant`, `listProvisionedTenants`, `listTenants`, `map`
|
||||
`createDebugger`, `slugify`, `toLowerCase`, `replace`, `slice`, `validateVeraeCredentials`, `login`, `selfServeSignup`, `bindUser`, `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.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/timestampService.js`
|
||||
**Lines:** 170
|
||||
**Lines:** 171
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -53,13 +53,14 @@ _None extracted._
|
|||
- `../config.js`
|
||||
- `../clients/veraeClient.js`
|
||||
- `../store/jobWatchers.js`
|
||||
- `../store/tokenRefs.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`, `waitForJobEvent`, `getStatus`, `waitForJob`, `createBatchTimestamp`, `getJobStatus`, `getBatchJobStatus`, `getBatchStatus`, `getJobVerification`, `lookupHash`
|
||||
`createDebugger`, `enqueueWatchForJob`, `getTraceId`, `import`, `enqueueWatch`, `issueTokenRef`, `debug`, `enqueueJob`, `createTimestamp`, `checkEntitlement`, `recordUsage`, `createTimestampAndWait`, `waitForJobEvent`, `getStatus`, `waitForJob`, `createBatchTimestamp`, `getJobStatus`, `getBatchJobStatus`, `getBatchStatus`, `getJobVerification`, `lookupHash`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/store/db.js`
|
||||
**Lines:** 118
|
||||
**Lines:** 120
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/store/tenants.js`
|
||||
**Lines:** 138
|
||||
**Lines:** 142
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -30,8 +30,9 @@ _None extracted._
|
|||
plan = 'free',
|
||||
veraeUsername,
|
||||
veraePassword,
|
||||
veraeUserId,
|
||||
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 |
|
||||
apiKey = generateApiKey(` | params: `object`, params.id: `string`, params.name: `string`, params.plan: `string`, params.veraeUsername: `string`, params.veraePassword: `string`, params.veraeUserId: `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,
|
||||
|
|
|
|||
48
docs/modules/verae-zapier-middleware/store/tokenRefs.md
Normal file
48
docs/modules/verae-zapier-middleware/store/tokenRefs.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
# `verae-zapier-middleware/store/tokenRefs`
|
||||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/store/tokenRefs.js`
|
||||
**Lines:** 21
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`issueTokenRef`, `resolveTokenRef`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `issueTokenRef` | `tenantId` | — | `unknown` | see Call graph |
|
||||
| `resolveTokenRef` | `ref` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `persist` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
- `./db.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`issueTokenRef`, `randomBytes`, `toString`, `getStore`, `toISOString`, `persist`, `resolveTokenRef`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/workers/jobPollerWorker.js`
|
||||
**Lines:** 159
|
||||
**Lines:** 161
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -34,11 +34,12 @@ _None extracted._
|
|||
- `../nats/publishers.js`
|
||||
- `../clients/veraeClient.js`
|
||||
- `../store/tenants.js`
|
||||
- `../store/tokenRefs.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`
|
||||
`createDebugger`, `polling`, `resolveVeraeToken`, `resolveTokenRef`, `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.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `zappier-account-balance`
|
||||
**Source:** `packages/zappier-account-balance/src/books.js`
|
||||
**Lines:** 90
|
||||
**Lines:** 100
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -30,8 +30,9 @@ Implementation module in `zappier-account-balance`. The tables below are extract
|
|||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `(none)` |
|
||||
| `remember` | `customerId, veraeUserId` |
|
||||
| `prepaidCents` | `customerId` |
|
||||
| `adjust` | `{ customerId, cents, reason, agent, kind = 'credit' }` |
|
||||
| `adjust` | `{ customerId, cents, reason, agent, kind = 'credit', veraeUserId }` |
|
||||
| `recordUsage` | `entry` |
|
||||
| `recordPayment` | `entry` |
|
||||
| `statement` | `customerId` |
|
||||
|
|
@ -42,7 +43,7 @@ _No imports detected._
|
|||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`constructor`, `prepaidCents`, `adjust`, `trunc`, `now`, `toString`, `random`, `slice`, `toISOString`, `unshift`, `recordUsage`, `recordPayment`, `statement`, `filter`, `match`, `handle`, `endsWith`
|
||||
`constructor`, `remember`, `prepaidCents`, `adjust`, `trunc`, `now`, `toString`, `random`, `slice`, `toISOString`, `unshift`, `recordUsage`, `recordPayment`, `statement`, `filter`, `match`, `handle`, `endsWith`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/admin.ts`
|
||||
**Lines:** 591
|
||||
**Lines:** 593
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/app.ts`
|
||||
**Lines:** 272
|
||||
**Lines:** 278
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -52,7 +52,7 @@ Implementation module in `zappier`. The tables below are extracted from the sour
|
|||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `next`, `parse`, `status`, `json`, `buildApp`, `seeded`, `seedAdminUsersFromEnv`, `rateCard`, `getRateCard`, `tiers`, `getTiers`, `natsPublish`, `toISOString`, `express`, `use`, `load`, `setup`, `adminLoginRouter`, `adminAuth`, `adminRouter`, `static`, `async`, `import`, `toDataURL`, `portalRouter`, `get`, `apiKeyAuth`, `middleware`, `meter`, `post`, `toUpperCase`, `proxyVerae`, `toLowerCase`, `createHash`, `update`, `digest`, `randomUUID`, `set`, `isFinite`, `map`, `unshift`, `filter`, `setUTCDate`, `setUTCHours`, `summaryFor`, `find`, `applyMonthlyCredit`
|
||||
`join`, `next`, `parse`, `status`, `json`, `buildApp`, `seeded`, `seedAdminUsersFromEnv`, `rateCard`, `getRateCard`, `tiers`, `getTiers`, `list`, `find`, `natsPublish`, `toISOString`, `express`, `use`, `load`, `setup`, `adminLoginRouter`, `adminAuth`, `adminRouter`, `static`, `async`, `import`, `toDataURL`, `portalRouter`, `get`, `apiKeyAuth`, `middleware`, `meter`, `post`, `toUpperCase`, `proxyVerae`, `toLowerCase`, `createHash`, `update`, `digest`, `randomUUID`, `set`, `isFinite`, `map`, `unshift`, `filter`, `setUTCDate`, `setUTCHours`, `summaryFor`, `applyMonthlyCredit`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/auth.ts`
|
||||
**Lines:** 84
|
||||
**Lines:** 87
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ Implementation module in `zappier`. The tables below are extracted from the sour
|
|||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`findByApiKey`, `findByEmail`, `list`, `save`, `constructor`, `arrays`, `map`, `find`, `toLowerCase`, `findIndex`, `push`, `apiKeyAuth`, `header`, `status`, `json`, `next`
|
||||
`id`, `findByApiKey`, `findByEmail`, `list`, `save`, `constructor`, `arrays`, `map`, `find`, `toLowerCase`, `findIndex`, `push`, `apiKeyAuth`, `header`, `status`, `json`, `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.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/billing-nats.ts`
|
||||
**Lines:** 130
|
||||
**Lines:** 138
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -29,11 +29,13 @@ Implementation module in `zappier`. The tables below are extracted from the sour
|
|||
| `decode` | `buf: Uint8Array` | — | `unknown` | see Call graph |
|
||||
| `authzAllow` | `plane: AccessPlane,
|
||||
subject: string,
|
||||
extra: { principal?: string; kind?: string } = {},` | — | `unknown` | see Call graph |
|
||||
extra: { principal?: string; kind?: string; veraeUserId?: string } = {},` | — | `unknown` | see Call graph |
|
||||
| `natsStatement` | `customerId: string,
|
||||
plane: AccessPlane = 'web',` | — | `unknown` | see Call graph |
|
||||
plane: AccessPlane = 'web',
|
||||
veraeUserId?: string,` | — | `unknown` | see Call graph |
|
||||
| `natsAdjust` | `payload: {
|
||||
customerId: string;
|
||||
veraeUserId?: string;
|
||||
cents: number;
|
||||
reason: string;
|
||||
agent: string;
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/portal.ts`
|
||||
**Lines:** 328
|
||||
**Lines:** 337
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -51,10 +51,11 @@ Implementation module in `zappier`. The tables below are extracted from the sour
|
|||
- `./credits`
|
||||
- `./statement`
|
||||
- `./billing-nats`
|
||||
- `./verae-bind`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`now`, `reload`, `customer`, `publicProfile`, `sessionAuth`, `header`, `startsWith`, `slice`, `get`, `list`, `find`, `status`, `json`, `next`, `save`, `portalRouter`, `post`, `trim`, `test`, `hashPassword`, `findByEmail`, `randomBytes`, `toString`, `create`, `verifyPassword`, `verifyTotp`, `use`, `delete`, `setUTCDate`, `setUTCHours`, `summaryFor`, `tiers`, `applyMonthlyCredit`, `rateCard`, `async`, `natsStatement`, `composeStatement`, `listFor`, `type`, `send`, `renderInvoiceHtml`, `generateTotpSecret`, `totpUri`, `qr`, `isInteger`, `natsPublish`, `natsAdjust`, `put`
|
||||
`now`, `reload`, `customer`, `publicProfile`, `sessionAuth`, `header`, `startsWith`, `slice`, `get`, `list`, `find`, `status`, `json`, `next`, `save`, `portalRouter`, `post`, `async`, `trim`, `test`, `hashPassword`, `findByEmail`, `randomBytes`, `toString`, `bindVeraeUser`, `create`, `verifyPassword`, `verifyTotp`, `use`, `delete`, `setUTCDate`, `setUTCHours`, `summaryFor`, `tiers`, `applyMonthlyCredit`, `rateCard`, `natsStatement`, `composeStatement`, `listFor`, `type`, `send`, `renderInvoiceHtml`, `generateTotpSecret`, `totpUri`, `qr`, `isInteger`, `natsPublish`, `natsAdjust`, `put`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/statement.ts`
|
||||
**Lines:** 39
|
||||
**Lines:** 41
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -22,6 +22,7 @@ _None extracted._
|
|||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `composeStatement` | `args: {
|
||||
customerId: string;
|
||||
veraeUserId?: string;
|
||||
prepaidCents: number;
|
||||
credits: CreditAdjustment[];
|
||||
usage: UsageEntry[];
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/upstream.ts`
|
||||
**Lines:** 46
|
||||
**Lines:** 48
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
|
|||
46
docs/modules/zappier/verae-bind.md
Normal file
46
docs/modules/zappier/verae-bind.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# `zappier/verae-bind`
|
||||
|
||||
**Package:** `zappier`
|
||||
**Source:** `packages/zappier/src/verae-bind.ts`
|
||||
**Lines:** 77
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `zappier`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`normalizeVeraeUsername`, `stableVeraeUserId`, `VeraeBind`, `bindVeraeUser`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| type | `VeraeBind` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `normalizeVeraeUsername` | `username: string` | — | `unknown` | see Call graph |
|
||||
| `stableVeraeUserId` | `username: string` | — | `unknown` | see Call graph |
|
||||
| `mockBind` | `email: string` | — | `unknown` | see Call graph |
|
||||
| `bindVeraeUser` | `email: string` | — | `unknown` | see Call graph |
|
||||
| `login` | `username: string, pass: string` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`normalizeVeraeUsername`, `trim`, `toLowerCase`, `stableVeraeUserId`, `createHash`, `update`, `digest`, `slice`, `mockBind`, `bindVeraeUser`, `replace`, `randomBytes`, `toString`, `async`, `fetch`, `stringify`, `json`, `login`
|
||||
|
||||
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